Skip to main content
Version: Next

REST API Reference

Superset exposes a comprehensive REST API that follows the OpenAPI specification. You can use this API to programmatically interact with Superset for automation, integrations, and custom applications.


Authentication

Most API endpoints require authentication via JWT tokens.

Quick Start

# 1. Get a JWT token
curl -X POST http://localhost:8088/api/v1/security/login \
-H "Content-Type: application/json" \
-d '{"username": "admin", "password": "admin", "provider": "db"}'

# 2. Use the access_token from the response
curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
http://localhost:8088/api/v1/dashboard/

Security Endpoints

MethodEndpointDescription
GETGet the CSRF token/api/v1/security/csrf_token/
POSTGet a guest token/api/v1/security/guest_token/
POSTCreate security login/api/v1/security/login
POSTCreate security refresh/api/v1/security/refresh

API Endpoints

Core Resources

Dashboards (35 endpoints) — Create, read, update, and delete dashboards.
MethodEndpointDescription
DELETEBulk delete dashboards (soft delete, recoverable via restore, when the SOFT_DELETE feature flag is enabled; permanent otherwise)/api/v1/dashboard/
GETGet a list of dashboards/api/v1/dashboard/
POSTCreate a new dashboard/api/v1/dashboard/
GETGet metadata information about this API resource (dashboard--info)/api/v1/dashboard/_info
GETGet a dashboard detail information/api/v1/dashboard/{id_or_slug}
GETGet a dashboard's chart definitions./api/v1/dashboard/{id_or_slug}/charts
POSTCreate a copy of an existing dashboard/api/v1/dashboard/{id_or_slug}/copy/
GETGet dashboard's datasets/api/v1/dashboard/{id_or_slug}/datasets
DELETEDelete a dashboard's embedded configuration/api/v1/dashboard/{id_or_slug}/embedded
GETGet the dashboard's embedded configuration/api/v1/dashboard/{id_or_slug}/embedded
POSTSet a dashboard's embedded configuration/api/v1/dashboard/{id_or_slug}/embedded
PUTUpdate dashboard by id_or_slug embedded/api/v1/dashboard/{id_or_slug}/embedded
GETGet dashboard's tabs/api/v1/dashboard/{id_or_slug}/tabs
DELETEDelete a dashboard (soft delete, recoverable via restore, when the SOFT_DELETE feature flag is enabled; permanent otherwise)/api/v1/dashboard/{pk}
PUTUpdate a dashboard/api/v1/dashboard/{pk}
POSTCompute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)/api/v1/dashboard/{pk}/cache_dashboard_screenshot/
PUTUpdate chart customizations configuration for a dashboard./api/v1/dashboard/{pk}/chart_customizations
PUTUpdate colors configuration for a dashboard./api/v1/dashboard/{pk}/colors
GETExport dashboard as example bundle/api/v1/dashboard/{pk}/export_as_example/
POSTExport dashboard chart data to Excel/api/v1/dashboard/{pk}/export_xlsx/
DELETERemove the dashboard from the user favorite list/api/v1/dashboard/{pk}/favorites/
POSTMark the dashboard as favorite for the current user/api/v1/dashboard/{pk}/favorites/
PUTUpdate native filters configuration for a dashboard./api/v1/dashboard/{pk}/filters
GETGet a computed screenshot from cache (dashboard-pk-screenshot-digest)/api/v1/dashboard/{pk}/screenshot/{digest}/
GETGet dashboard's thumbnail/api/v1/dashboard/{pk}/thumbnail/{digest}/
GETActivity stream — dashboard own edits + transitive chart-on-dashboard and dataset-via-chart edits, time-bounded by association windows/api/v1/dashboard/{uuid_str}/activity/
GETReturn the version history for a dashboard/api/v1/dashboard/{uuid_str}/versions/
GETRead-only snapshot of the dashboard at a given version/api/v1/dashboard/{uuid_str}/versions/{version_uuid_str}/
POSTRevert a dashboard to an earlier version (non-destructive)/api/v1/dashboard/{uuid_str}/versions/{version_uuid_str}/restore
POSTPermanently delete a soft-deleted dashboard/api/v1/dashboard/{uuid}/purge
POSTRestore a soft-deleted dashboard/api/v1/dashboard/{uuid}/restore
GETDownload multiple dashboards as YAML files/api/v1/dashboard/export/
GETCheck favorited dashboards for current user/api/v1/dashboard/favorite_status/
POSTImport dashboard(s) with associated charts/datasets/databases/api/v1/dashboard/import/
GETGet related fields data (dashboard-related-column-name)/api/v1/dashboard/related/{column_name}
Charts (27 endpoints) — Create, read, update, and delete charts (slices).
MethodEndpointDescription
DELETEBulk delete charts (soft delete, recoverable via restore, when the SOFT_DELETE feature flag is enabled; permanent otherwise)/api/v1/chart/
GETGet a list of charts/api/v1/chart/
POSTCreate a new chart/api/v1/chart/
GETGet metadata information about this API resource (chart--info)/api/v1/chart/_info
GETGet a chart detail information/api/v1/chart/{id_or_uuid}
DELETEDelete a chart (soft delete, recoverable via restore, when the SOFT_DELETE feature flag is enabled; permanent otherwise)/api/v1/chart/{pk}
PUTUpdate a chart/api/v1/chart/{pk}
GETCompute and cache a screenshot (chart-pk-cache-screenshot)/api/v1/chart/{pk}/cache_screenshot/
GETReturn payload data response for a chart/api/v1/chart/{pk}/data/
GETGet the sub-layer charts declared by a deck.gl Multiple Layers chart/api/v1/chart/{pk}/deck_layers/
DELETERemove the chart from the user favorite list/api/v1/chart/{pk}/favorites/
POSTMark the chart as favorite for the current user/api/v1/chart/{pk}/favorites/
GETGet a computed screenshot from cache (chart-pk-screenshot-digest)/api/v1/chart/{pk}/screenshot/{digest}/
GETGet chart thumbnail/api/v1/chart/{pk}/thumbnail/{digest}/
GETActivity stream — chart own edits + datasets the chart pointed at during association/api/v1/chart/{uuid_str}/activity/
GETReturn the version history for a chart/api/v1/chart/{uuid_str}/versions/
GETRead-only snapshot of the chart at a given version/api/v1/chart/{uuid_str}/versions/{version_uuid_str}/
POSTRevert a chart to an earlier version (non-destructive)/api/v1/chart/{uuid_str}/versions/{version_uuid_str}/restore
POSTPermanently delete a soft-deleted chart/api/v1/chart/{uuid}/purge
POSTRestore a soft-deleted chart/api/v1/chart/{uuid}/restore
POSTReturn payload data response for the given query (chart-data)/api/v1/chart/data
GETReturn payload data response for the given query (chart-data-cache-key)/api/v1/chart/data/{cache_key}
GETDownload multiple charts as YAML files/api/v1/chart/export/
GETCheck favorited charts for current user/api/v1/chart/favorite_status/
POSTImport chart(s) with associated datasets and databases/api/v1/chart/import/
GETGet related fields data (chart-related-column-name)/api/v1/chart/related/{column_name}
PUTWarm up the cache for the chart/api/v1/chart/warm_up_cache
Datasets (26 endpoints) — Manage datasets (tables) used for building charts.
MethodEndpointDescription
DELETEBulk delete datasets (soft delete, recoverable via restore, when the SOFT_DELETE feature flag is enabled; permanent otherwise)/api/v1/dataset/
GETGet a list of datasets/api/v1/dataset/
POSTCreate a new dataset/api/v1/dataset/
GETGet metadata information about this API resource (dataset--info)/api/v1/dataset/_info
GETGet a dataset/api/v1/dataset/{id_or_uuid}
GETGet charts and dashboards count associated to a dataset/api/v1/dataset/{id_or_uuid}/related_objects
DELETEDelete a dataset (soft delete, recoverable via restore, when the SOFT_DELETE feature flag is enabled; permanent otherwise)/api/v1/dataset/{pk}
PUTUpdate a dataset/api/v1/dataset/{pk}
DELETEDelete a dataset column/api/v1/dataset/{pk}/column/{column_id}
GETGet dataset drill info/api/v1/dataset/{pk}/drill_info/
DELETEDelete a dataset metric/api/v1/dataset/{pk}/metric/{metric_id}
PUTRefresh and update columns of a dataset/api/v1/dataset/{pk}/refresh
GETGet a dataset's activity stream/api/v1/dataset/{uuid_str}/activity/
GETReturn the version history for a dataset/api/v1/dataset/{uuid_str}/versions/
GETRead-only snapshot of the dataset at a given version/api/v1/dataset/{uuid_str}/versions/{version_uuid_str}/
POSTRevert a dataset to an earlier version (non-destructive)/api/v1/dataset/{uuid_str}/versions/{version_uuid_str}/restore
POSTPermanently delete a soft-deleted dataset/api/v1/dataset/{uuid}/purge
GETPreview the dependency impact of purging an archived dataset/api/v1/dataset/{uuid}/purge-impact
POSTRestore a soft-deleted dataset/api/v1/dataset/{uuid}/restore
GETGet distinct values from field data (dataset-distinct-column-name)/api/v1/dataset/distinct/{column_name}
POSTDuplicate a dataset/api/v1/dataset/duplicate
GETDownload multiple datasets as YAML files/api/v1/dataset/export/
POSTRetrieve a table by name, or create it if it does not exist/api/v1/dataset/get_or_create/
POSTImport dataset(s) with associated databases/api/v1/dataset/import/
GETGet related fields data (dataset-related-column-name)/api/v1/dataset/related/{column_name}
PUTWarm up the cache for each chart powered by the given table/api/v1/dataset/warm_up_cache
Database (30 endpoints) — Manage database connections and metadata.
MethodEndpointDescription
GETGet a list of databases/api/v1/database/
POSTCreate a new database/api/v1/database/
GETGet metadata information about this API resource (database--info)/api/v1/database/_info
DELETEDelete a database/api/v1/database/{pk}
GETGet a database/api/v1/database/{pk}
PUTChange a database/api/v1/database/{pk}
GETGet all catalogs from a database/api/v1/database/{pk}/catalogs/
GETGet a database connection info/api/v1/database/{pk}/connection
GETGet function names supported by a database/api/v1/database/{pk}/function_names/
GETGet charts and dashboards count associated to a database/api/v1/database/{pk}/related_objects/
GETThe list of the database schemas where to upload information/api/v1/database/{pk}/schemas_access_for_file_upload/
GETGet all schemas from a database/api/v1/database/{pk}/schemas/
GETGet database select star for table (database-pk-select-star-table-name)/api/v1/database/{pk}/select_star/{table_name}/
GETGet database select star for table (database-pk-select-star-table-name-schema-name)/api/v1/database/{pk}/select_star/{table_name}/{schema_name}/
POSTRe-sync all permissions for a database connection/api/v1/database/{pk}/sync_permissions/
GETGet table extra metadata (database-pk-table-extra-table-name-schema-name)/api/v1/database/{pk}/table_extra/{table_name}/{schema_name}/
GETGet table metadata/api/v1/database/{pk}/table_metadata/
GETGet table extra metadata (database-pk-table-metadata-extra)/api/v1/database/{pk}/table_metadata/extra/
GETGet database table metadata/api/v1/database/{pk}/table/{table_name}/{schema_name}/
GETGet a list of tables for given database/api/v1/database/{pk}/tables/
POSTUpload a file to a database table/api/v1/database/{pk}/upload/
POSTValidate arbitrary SQL/api/v1/database/{pk}/validate_sql/
GETGet names of databases currently available/api/v1/database/available/
GETDownload database(s) and associated dataset(s) as a zip file/api/v1/database/export/
POSTImport database(s) with associated datasets/api/v1/database/import/
GETReceive personal access tokens from OAuth2/api/v1/database/oauth2/
GETGet related fields data (database-related-column-name)/api/v1/database/related/{column_name}
POSTTest a database connection/api/v1/database/test_connection/
POSTUpload a file and returns file metadata/api/v1/database/upload_metadata/
POSTValidate database connection parameters/api/v1/database/validate_parameters/

Data Exploration

Explore (1 endpoints) — Chart exploration and data querying endpoints.
MethodEndpointDescription
GETAssemble Explore related information in a single endpoint/api/v1/explore/
SQL Lab (7 endpoints) — Execute SQL queries and manage SQL Lab sessions.
MethodEndpointDescription
GETGet the bootstrap data for SqlLab page/api/v1/sqllab/
POSTEstimate the SQL query execution cost/api/v1/sqllab/estimate/
POSTExecute a SQL query/api/v1/sqllab/execute/
POSTExport SQL query results to CSV with streaming/api/v1/sqllab/export_streaming/
GETExport the SQL query results to a CSV/api/v1/sqllab/export/{client_id}/
POSTFormat SQL code/api/v1/sqllab/format_sql/
GETGet the result of a SQL query execution/api/v1/sqllab/results/
Queries (17 endpoints) — View and manage SQL Lab query history.
MethodEndpointDescription
GETGet a list of queries/api/v1/query/
GETGet query detail information/api/v1/query/{pk}
GETGet distinct values from field data (query-distinct-column-name)/api/v1/query/distinct/{column_name}
GETGet related fields data (query-related-column-name)/api/v1/query/related/{column_name}
POSTManually stop a query with client_id/api/v1/query/stop
GETGet a list of queries that changed after last_updated_ms/api/v1/query/updated_since
DELETEBulk delete saved queries/api/v1/saved_query/
GETGet a list of saved queries/api/v1/saved_query/
POSTCreate a saved query/api/v1/saved_query/
GETGet metadata information about this API resource (saved-query--info)/api/v1/saved_query/_info
DELETEDelete a saved query/api/v1/saved_query/{pk}
GETGet a saved query/api/v1/saved_query/{pk}
PUTUpdate a saved query/api/v1/saved_query/{pk}
GETGet distinct values from field data (saved-query-distinct-column-name)/api/v1/saved_query/distinct/{column_name}
GETDownload multiple saved queries as YAML files/api/v1/saved_query/export/
POSTImport saved queries with associated databases/api/v1/saved_query/import/
GETGet related fields data (saved-query-related-column-name)/api/v1/saved_query/related/{column_name}
Datasources (6 endpoints) — Query datasource metadata and column values.
MethodEndpointDescription
GETList datasets and semantic views combined/api/v1/datasource/
GETGet datasource metadata and capabilities/api/v1/datasource/{datasource_type}/{datasource_id}
GETGet possible values for a datasource column/api/v1/datasource/{datasource_type}/{datasource_id}/column/{column_name}/values/
POSTGet compatible metrics and dimensions/api/v1/datasource/{datasource_type}/{datasource_id}/compatible
POSTQuery a datasource by its semantic definitions/api/v1/datasource/{datasource_type}/{datasource_id}/query
POSTValidate a SQL expression against a datasource/api/v1/datasource/{datasource_type}/{datasource_id}/validate_expression/
Advanced Data Type (2 endpoints) — Advanced data type operations and conversions.
MethodEndpointDescription
GETReturn an AdvancedDataTypeResponse/api/v1/advanced_data_type/convert
GETReturn a list of available advanced data types/api/v1/advanced_data_type/types

Organization & Customization

Tags (15 endpoints) — Organize assets with tags.
MethodEndpointDescription
DELETEBulk delete tags/api/v1/tag/
GETGet a list of tags/api/v1/tag/
POSTCreate a tag/api/v1/tag/
GETGet metadata information about tag API endpoints/api/v1/tag/_info
POSTAdd tags to an object/api/v1/tag/{object_type}/{object_id}/
DELETEDelete a tagged object/api/v1/tag/{object_type}/{object_id}/{tag}/
DELETEDelete a tag/api/v1/tag/{pk}
GETGet a tag detail information/api/v1/tag/{pk}
PUTUpdate a tag/api/v1/tag/{pk}
DELETEDelete tag by pk favorites/api/v1/tag/{pk}/favorites/
POSTCreate tag by pk favorites/api/v1/tag/{pk}/favorites/
POSTBulk create tags and tagged objects/api/v1/tag/bulk_create
GETGet tag favorite status/api/v1/tag/favorite_status/
GETGet all objects associated with a tag/api/v1/tag/get_objects/
GETGet related fields data (tag-related-column-name)/api/v1/tag/related/{column_name}
Annotation Layers (14 endpoints) — Manage annotation layers and annotations for charts.
MethodEndpointDescription
DELETEDelete multiple annotation layers in a bulk operation/api/v1/annotation_layer/
GETGet a list of annotation layers (annotation-layer)/api/v1/annotation_layer/
POSTCreate an annotation layer (annotation-layer)/api/v1/annotation_layer/
GETGet metadata information about this API resource (annotation-layer--info)/api/v1/annotation_layer/_info
DELETEDelete annotation layer (annotation-layer-pk)/api/v1/annotation_layer/{pk}
GETGet an annotation layer (annotation-layer-pk)/api/v1/annotation_layer/{pk}
PUTUpdate an annotation layer (annotation-layer-pk)/api/v1/annotation_layer/{pk}
DELETEBulk delete annotation layers/api/v1/annotation_layer/{pk}/annotation/
GETGet a list of annotation layers (annotation-layer-pk-annotation)/api/v1/annotation_layer/{pk}/annotation/
POSTCreate an annotation layer (annotation-layer-pk-annotation)/api/v1/annotation_layer/{pk}/annotation/
DELETEDelete annotation layer (annotation-layer-pk-annotation-annotation-id)/api/v1/annotation_layer/{pk}/annotation/{annotation_id}
GETGet an annotation layer (annotation-layer-pk-annotation-annotation-id)/api/v1/annotation_layer/{pk}/annotation/{annotation_id}
PUTUpdate an annotation layer (annotation-layer-pk-annotation-annotation-id)/api/v1/annotation_layer/{pk}/annotation/{annotation_id}
GETGet related fields data (annotation-layer-related-column-name)/api/v1/annotation_layer/related/{column_name}
CSS Templates (8 endpoints) — Manage CSS templates for custom dashboard styling.
MethodEndpointDescription
DELETEBulk delete CSS templates/api/v1/css_template/
GETGet a list of CSS templates/api/v1/css_template/
POSTCreate a CSS template/api/v1/css_template/
GETGet metadata information about this API resource (css-template--info)/api/v1/css_template/_info
DELETEDelete a CSS template/api/v1/css_template/{pk}
GETGet a CSS template/api/v1/css_template/{pk}
PUTUpdate a CSS template/api/v1/css_template/{pk}
GETGet related fields data (css-template-related-column-name)/api/v1/css_template/related/{column_name}

Sharing & Embedding

Dashboard Permanent Link (2 endpoints) — Permanent links to dashboard states.
MethodEndpointDescription
POSTCreate a new dashboard's permanent link/api/v1/dashboard/{pk}/permalink
GETGet dashboard's permanent link state/api/v1/dashboard/permalink/{key}
Explore Permanent Link (2 endpoints) — Permanent links to chart explore states.
MethodEndpointDescription
POSTCreate a new permanent link (explore-permalink)/api/v1/explore/permalink
GETGet chart's permanent link state/api/v1/explore/permalink/{key}
SQL Lab Permanent Link (2 endpoints) — Permanent links to SQL Lab states.
MethodEndpointDescription
POSTCreate a new permanent link (sqllab-permalink)/api/v1/sqllab/permalink
GETGet permanent link state for SQLLab editor./api/v1/sqllab/permalink/{key}
Embedded Dashboard (1 endpoints) — Configure embedded dashboard settings.
MethodEndpointDescription
GETGet a report schedule log (embedded-dashboard-uuid)/api/v1/embedded_dashboard/{uuid}
Dashboard Filter State (4 endpoints) — Manage temporary filter state for dashboards.
MethodEndpointDescription
POSTCreate a dashboard's filter state/api/v1/dashboard/{pk}/filter_state
DELETEDelete a dashboard's filter state value/api/v1/dashboard/{pk}/filter_state/{key}
GETGet a dashboard's filter state value/api/v1/dashboard/{pk}/filter_state/{key}
PUTUpdate a dashboard's filter state value/api/v1/dashboard/{pk}/filter_state/{key}
Explore Form Data (4 endpoints) — Manage temporary form data for chart exploration.
MethodEndpointDescription
POSTCreate a new form_data/api/v1/explore/form_data
DELETEDelete a form_data/api/v1/explore/form_data/{key}
GETGet a form_data/api/v1/explore/form_data/{key}
PUTUpdate an existing form_data/api/v1/explore/form_data/{key}

Scheduling & Alerts

Report Schedules (13 endpoints) — Configure scheduled reports and alerts.
MethodEndpointDescription
DELETEBulk delete report schedules/api/v1/report/
GETGet a list of report schedules/api/v1/report/
POSTCreate a report schedule/api/v1/report/
GETGet metadata information about this API resource (report--info)/api/v1/report/_info
DELETEDelete a report schedule/api/v1/report/{pk}
GETGet a report schedule/api/v1/report/{pk}
PUTUpdate a report schedule/api/v1/report/{pk}
POSTExecute a report schedule immediately/api/v1/report/{pk}/execute
GETGet a list of report schedule logs/api/v1/report/{pk}/log/
GETGet a report schedule log (report-pk-log-log-id)/api/v1/report/{pk}/log/{log_id}
GETGet related fields data (report-related-column-name)/api/v1/report/related/{column_name}
GETGet slack channels/api/v1/report/slack_channels/
POSTSubscribe to a chart or dashboard report/api/v1/report/subscribe

Security & Access Control

Security Roles (11 endpoints) — Manage security roles and their permissions.
MethodEndpointDescription
GETGet security roles/api/v1/security/roles/
POSTCreate security roles/api/v1/security/roles/
GETGet security roles info/api/v1/security/roles/_info
DELETEDelete security roles by pk/api/v1/security/roles/{pk}
GETGet security roles by pk/api/v1/security/roles/{pk}
PUTUpdate security roles by pk/api/v1/security/roles/{pk}
PUTUpdate security roles by role_id groups/api/v1/security/roles/{role_id}/groups
POSTCreate security roles by role_id permissions/api/v1/security/roles/{role_id}/permissions
GETGet security roles by role_id permissions/api/v1/security/roles/{role_id}/permissions/
PUTUpdate security roles by role_id users/api/v1/security/roles/{role_id}/users
GETList roles/api/v1/security/roles/search/
Security Users (7 endpoints) — Manage user accounts.
MethodEndpointDescription
GETGet security users/api/v1/security/users/
POSTCreate security users/api/v1/security/users/
GETGet security users info/api/v1/security/users/_info
DELETEDelete security users by pk/api/v1/security/users/{pk}
GETGet security users by pk/api/v1/security/users/{pk}
PUTUpdate security users by pk/api/v1/security/users/{pk}
DELETEDelete security users by pk sessions/api/v1/security/users/{pk}/sessions
Security Permissions (3 endpoints) — View available permissions.
MethodEndpointDescription
GETGet security permissions/api/v1/security/permissions/
GETGet security permissions info/api/v1/security/permissions/_info
GETGet security permissions by pk/api/v1/security/permissions/{pk}
Security Resources (View Menus) (6 endpoints) — Manage security resources (view menus).
MethodEndpointDescription
GETGet security resources/api/v1/security/resources/
POSTCreate security resources/api/v1/security/resources/
GETGet security resources info/api/v1/security/resources/_info
DELETEDelete security resources by pk/api/v1/security/resources/{pk}
GETGet security resources by pk/api/v1/security/resources/{pk}
PUTUpdate security resources by pk/api/v1/security/resources/{pk}
Security Permissions on Resources (View Menus) (6 endpoints) — Permission-resource mappings.
MethodEndpointDescription
GETGet security permissions resources/api/v1/security/permissions-resources/
POSTCreate security permissions resources/api/v1/security/permissions-resources/
GETGet security permissions resources info/api/v1/security/permissions-resources/_info
DELETEDelete security permissions resources by pk/api/v1/security/permissions-resources/{pk}
GETGet security permissions resources by pk/api/v1/security/permissions-resources/{pk}
PUTUpdate security permissions resources by pk/api/v1/security/permissions-resources/{pk}
Row Level Security (8 endpoints) — Manage row-level security rules for data access.
MethodEndpointDescription
DELETEBulk delete RLS rules/api/v1/rowlevelsecurity/
GETGet a list of RLS/api/v1/rowlevelsecurity/
POSTCreate a new RLS rule/api/v1/rowlevelsecurity/
GETGet metadata information about this API resource (rowlevelsecurity--info)/api/v1/rowlevelsecurity/_info
DELETEDelete an RLS/api/v1/rowlevelsecurity/{pk}
GETGet an RLS/api/v1/rowlevelsecurity/{pk}
PUTUpdate an RLS rule/api/v1/rowlevelsecurity/{pk}
GETGet related fields data (rowlevelsecurity-related-column-name)/api/v1/rowlevelsecurity/related/{column_name}

Import/Export & Administration

Import/export (2 endpoints) — Import and export Superset assets.
MethodEndpointDescription
GETExport all assets/api/v1/assets/export/
POSTImport multiple assets/api/v1/assets/import/
CacheRestApi (1 endpoints) — Cache management and invalidation operations.
MethodEndpointDescription
POSTInvalidate cache records and remove the database records/api/v1/cachekey/invalidate
LogRestApi (4 endpoints) — Access audit logs and activity history.
MethodEndpointDescription
GETGet a list of logs/api/v1/log/
POSTCreate log/api/v1/log/
GETGet a log detail information/api/v1/log/{pk}
GETGet recent activity data for a user/api/v1/log/recent_activity/

User & System

Current User (3 endpoints) — Get information about the authenticated user.
MethodEndpointDescription
GETGet the user object/api/v1/me/
PUTUpdate the current user/api/v1/me/
GETGet the user roles/api/v1/me/roles/
User (1 endpoints) — User profile and preferences.
MethodEndpointDescription
GETGet the user avatar/api/v1/user/{user_id}/avatar.png
Menu (1 endpoints) — Get the Superset menu structure.
MethodEndpointDescription
GETGet menu/api/v1/menu/
Available Domains (1 endpoints) — Get available domains for the Superset instance.
MethodEndpointDescription
GETGet all available domains/api/v1/available_domains/
AsyncEventsRestApi (2 endpoints) — Real-time event streaming via Server-Sent Events (SSE).
MethodEndpointDescription
GETRead off of the Redis events stream/api/v1/async_event/
POSTCancel a running async query job/api/v1/async_event/{job_id}/cancel

Other

Security Groups (6 endpoints) — Endpoints related to Security Groups.
MethodEndpointDescription
GETGet security groups/api/v1/security/groups/
POSTCreate security groups/api/v1/security/groups/
GETGet security groups info/api/v1/security/groups/_info
DELETEDelete security groups by pk/api/v1/security/groups/{pk}
GETGet security groups by pk/api/v1/security/groups/{pk}
PUTUpdate security groups by pk/api/v1/security/groups/{pk}
Security Subjects (3 endpoints) — Endpoints related to Security Subjects.
MethodEndpointDescription
GETGet a list of Subjects/api/v1/security/subject/
GETGet metadata information about this API resource (security-subject--info)/api/v1/security/subject/_info
GETGet a Subject/api/v1/security/subject/{pk}
Themes (15 endpoints) — Manage UI themes for customizing Superset's appearance.
MethodEndpointDescription
DELETEBulk delete themes/api/v1/theme/
GETGet a list of themes/api/v1/theme/
POSTCreate a theme/api/v1/theme/
GETGet metadata information about this API resource (theme--info)/api/v1/theme/_info
DELETEDelete a theme/api/v1/theme/{pk}
GETGet a theme/api/v1/theme/{pk}
PUTUpdate a theme/api/v1/theme/{pk}
PUTSet a theme as the system dark theme/api/v1/theme/{pk}/set_system_dark
PUTSet a theme as the system default theme/api/v1/theme/{pk}/set_system_default
GETDownload multiple themes as YAML files/api/v1/theme/export/
POSTImport themes from a ZIP file/api/v1/theme/import/
GETGet related fields data (theme-related-column-name)/api/v1/theme/related/{column_name}
GETGet the resolved system default and dark themes/api/v1/theme/system
DELETEClear the system dark theme/api/v1/theme/unset_system_dark
DELETEClear the system default theme/api/v1/theme/unset_system_default
UserRegistrationsRestAPI (4 endpoints) — Endpoints related to UserRegistrationsRestAPI.
MethodEndpointDescription
GETGet security user registrations/api/v1/security/user_registrations/
GETGet security user registrations info/api/v1/security/user_registrations/_info
DELETEDelete security user registrations by pk/api/v1/security/user_registrations/{pk}
GETGet security user registrations by pk/api/v1/security/user_registrations/{pk}

Additional Resources