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.

Code Samples & Schema Documentation

Each endpoint includes ready-to-use code samples in cURL, Python, and JavaScript. Browse the Schema definitions for detailed data model documentation.

---

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

Method	Endpoint	Description
GET	Get the CSRF token	/api/v1/security/csrf_token/
POST	Get a guest token	/api/v1/security/guest_token/
POST	Create security login	/api/v1/security/login
POST	Create security refresh	/api/v1/security/refresh

---

API Endpoints

Core Resources

Dashboards (26 endpoints) — Create, read, update, and delete dashboards.

Method	Endpoint	Description
DELETE	Bulk delete dashboards	/api/v1/dashboard/
GET	Get a list of dashboards	/api/v1/dashboard/
POST	Create a new dashboard	/api/v1/dashboard/
GET	Get metadata information about this API resource (dashboard--info)	/api/v1/dashboard/_info
GET	Get a dashboard detail information	/api/v1/dashboard/{id_or_slug}
GET	Get a dashboard's chart definitions.	/api/v1/dashboard/{id_or_slug}/charts
POST	Create a copy of an existing dashboard	/api/v1/dashboard/{id_or_slug}/copy/
GET	Get dashboard's datasets	/api/v1/dashboard/{id_or_slug}/datasets
DELETE	Delete a dashboard's embedded configuration	/api/v1/dashboard/{id_or_slug}/embedded
GET	Get the dashboard's embedded configuration	/api/v1/dashboard/{id_or_slug}/embedded
POST	Set a dashboard's embedded configuration	/api/v1/dashboard/{id_or_slug}/embedded
PUT	Update dashboard by id_or_slug embedded	/api/v1/dashboard/{id_or_slug}/embedded
GET	Get dashboard's tabs	/api/v1/dashboard/{id_or_slug}/tabs
DELETE	Delete a dashboard	/api/v1/dashboard/{pk}
PUT	Update a dashboard	/api/v1/dashboard/{pk}
POST	Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)	/api/v1/dashboard/{pk}/cache_dashboard_screenshot/
PUT	Update colors configuration for a dashboard.	/api/v1/dashboard/{pk}/colors
DELETE	Remove the dashboard from the user favorite list	/api/v1/dashboard/{pk}/favorites/
POST	Mark the dashboard as favorite for the current user	/api/v1/dashboard/{pk}/favorites/
PUT	Update native filters configuration for a dashboard.	/api/v1/dashboard/{pk}/filters
GET	Get a computed screenshot from cache (dashboard-pk-screenshot-digest)	/api/v1/dashboard/{pk}/screenshot/{digest}/
GET	Get dashboard's thumbnail	/api/v1/dashboard/{pk}/thumbnail/{digest}/
GET	Download multiple dashboards as YAML files	/api/v1/dashboard/export/
GET	Check favorited dashboards for current user	/api/v1/dashboard/favorite_status/
POST	Import dashboard(s) with associated charts/datasets/databases	/api/v1/dashboard/import/
GET	Get related fields data (dashboard-related-column-name)	/api/v1/dashboard/related/{column_name}

Charts (20 endpoints) — Create, read, update, and delete charts (slices).

Method	Endpoint	Description
DELETE	Bulk delete charts	/api/v1/chart/
GET	Get a list of charts	/api/v1/chart/
POST	Create a new chart	/api/v1/chart/
GET	Get metadata information about this API resource (chart--info)	/api/v1/chart/_info
DELETE	Delete a chart	/api/v1/chart/{pk}
GET	Get a chart detail information	/api/v1/chart/{pk}
PUT	Update a chart	/api/v1/chart/{pk}
GET	Compute and cache a screenshot (chart-pk-cache-screenshot)	/api/v1/chart/{pk}/cache_screenshot/
GET	Return payload data response for a chart	/api/v1/chart/{pk}/data/
DELETE	Remove the chart from the user favorite list	/api/v1/chart/{pk}/favorites/
POST	Mark the chart as favorite for the current user	/api/v1/chart/{pk}/favorites/
GET	Get a computed screenshot from cache (chart-pk-screenshot-digest)	/api/v1/chart/{pk}/screenshot/{digest}/
GET	Get chart thumbnail	/api/v1/chart/{pk}/thumbnail/{digest}/
POST	Return payload data response for the given query (chart-data)	/api/v1/chart/data
GET	Return payload data response for the given query (chart-data-cache-key)	/api/v1/chart/data/{cache_key}
GET	Download multiple charts as YAML files	/api/v1/chart/export/
GET	Check favorited charts for current user	/api/v1/chart/favorite_status/
POST	Import chart(s) with associated datasets and databases	/api/v1/chart/import/
GET	Get related fields data (chart-related-column-name)	/api/v1/chart/related/{column_name}
PUT	Warm up the cache for the chart	/api/v1/chart/warm_up_cache

Datasets (18 endpoints) — Manage datasets (tables) used for building charts.

Method	Endpoint	Description
DELETE	Bulk delete datasets	/api/v1/dataset/
GET	Get a list of datasets	/api/v1/dataset/
POST	Create a new dataset	/api/v1/dataset/
GET	Get metadata information about this API resource (dataset--info)	/api/v1/dataset/_info
DELETE	Delete a dataset	/api/v1/dataset/{pk}
GET	Get a dataset	/api/v1/dataset/{pk}
PUT	Update a dataset	/api/v1/dataset/{pk}
DELETE	Delete a dataset column	/api/v1/dataset/{pk}/column/{column_id}
DELETE	Delete a dataset metric	/api/v1/dataset/{pk}/metric/{metric_id}
PUT	Refresh and update columns of a dataset	/api/v1/dataset/{pk}/refresh
GET	Get charts and dashboards count associated to a dataset	/api/v1/dataset/{pk}/related_objects
GET	Get distinct values from field data (dataset-distinct-column-name)	/api/v1/dataset/distinct/{column_name}
POST	Duplicate a dataset	/api/v1/dataset/duplicate
GET	Download multiple datasets as YAML files	/api/v1/dataset/export/
POST	Retrieve a table by name, or create it if it does not exist	/api/v1/dataset/get_or_create/
POST	Import dataset(s) with associated databases	/api/v1/dataset/import/
GET	Get related fields data (dataset-related-column-name)	/api/v1/dataset/related/{column_name}
PUT	Warm up the cache for each chart powered by the given table	/api/v1/dataset/warm_up_cache

Database (31 endpoints) — Manage database connections and metadata.

Method	Endpoint	Description
GET	Get a list of databases	/api/v1/database/
POST	Create a new database	/api/v1/database/
GET	Get metadata information about this API resource (database--info)	/api/v1/database/_info
DELETE	Delete a database	/api/v1/database/{pk}
GET	Get a database	/api/v1/database/{pk}
PUT	Change a database	/api/v1/database/{pk}
GET	Get all catalogs from a database	/api/v1/database/{pk}/catalogs/
GET	Get a database connection info	/api/v1/database/{pk}/connection
GET	Get function names supported by a database	/api/v1/database/{pk}/function_names/
GET	Get charts and dashboards count associated to a database	/api/v1/database/{pk}/related_objects/
GET	The list of the database schemas where to upload information	/api/v1/database/{pk}/schemas_access_for_file_upload/
GET	Get all schemas from a database	/api/v1/database/{pk}/schemas/
GET	Get database select star for table (database-pk-select-star-table-name)	/api/v1/database/{pk}/select_star/{table_name}/
GET	Get database select star for table (database-pk-select-star-table-name-schema-name)	/api/v1/database/{pk}/select_star/{table_name}/{schema_name}/
DELETE	Delete a SSH tunnel	/api/v1/database/{pk}/ssh_tunnel/
POST	Re-sync all permissions for a database connection	/api/v1/database/{pk}/sync_permissions/
GET	Get table extra metadata (database-pk-table-extra-table-name-schema-name)	/api/v1/database/{pk}/table_extra/{table_name}/{schema_name}/
GET	Get table metadata	/api/v1/database/{pk}/table_metadata/
GET	Get table extra metadata (database-pk-table-metadata-extra)	/api/v1/database/{pk}/table_metadata/extra/
GET	Get database table metadata	/api/v1/database/{pk}/table/{table_name}/{schema_name}/
GET	Get a list of tables for given database	/api/v1/database/{pk}/tables/
POST	Upload a file to a database table	/api/v1/database/{pk}/upload/
POST	Validate arbitrary SQL	/api/v1/database/{pk}/validate_sql/
GET	Get names of databases currently available	/api/v1/database/available/
GET	Download database(s) and associated dataset(s) as a zip file	/api/v1/database/export/
POST	Import database(s) with associated datasets	/api/v1/database/import/
GET	Receive personal access tokens from OAuth2	/api/v1/database/oauth2/
GET	Get related fields data (database-related-column-name)	/api/v1/database/related/{column_name}
POST	Test a database connection	/api/v1/database/test_connection/
POST	Upload a file and returns file metadata	/api/v1/database/upload_metadata/
POST	Validate database connection parameters	/api/v1/database/validate_parameters/

Data Exploration

Explore (1 endpoints) — Chart exploration and data querying endpoints.

Method	Endpoint	Description
GET	Assemble Explore related information in a single endpoint	/api/v1/explore/

SQL Lab (6 endpoints) — Execute SQL queries and manage SQL Lab sessions.

Method	Endpoint	Description
GET	Get the bootstrap data for SqlLab page	/api/v1/sqllab/
POST	Estimate the SQL query execution cost	/api/v1/sqllab/estimate/
POST	Execute a SQL query	/api/v1/sqllab/execute/
GET	Export the SQL query results to a CSV	/api/v1/sqllab/export/{client_id}/
POST	Format SQL code	/api/v1/sqllab/format_sql/
GET	Get the result of a SQL query execution	/api/v1/sqllab/results/

Queries (17 endpoints) — View and manage SQL Lab query history.

Method	Endpoint	Description
GET	Get a list of queries	/api/v1/query/
GET	Get query detail information	/api/v1/query/{pk}
GET	Get distinct values from field data (query-distinct-column-name)	/api/v1/query/distinct/{column_name}
GET	Get related fields data (query-related-column-name)	/api/v1/query/related/{column_name}
POST	Manually stop a query with client_id	/api/v1/query/stop
GET	Get a list of queries that changed after last_updated_ms	/api/v1/query/updated_since
DELETE	Bulk delete saved queries	/api/v1/saved_query/
GET	Get a list of saved queries	/api/v1/saved_query/
POST	Create a saved query	/api/v1/saved_query/
GET	Get metadata information about this API resource (saved-query--info)	/api/v1/saved_query/_info
DELETE	Delete a saved query	/api/v1/saved_query/{pk}
GET	Get a saved query	/api/v1/saved_query/{pk}
PUT	Update a saved query	/api/v1/saved_query/{pk}
GET	Get distinct values from field data (saved-query-distinct-column-name)	/api/v1/saved_query/distinct/{column_name}
GET	Download multiple saved queries as YAML files	/api/v1/saved_query/export/
POST	Import saved queries with associated databases	/api/v1/saved_query/import/
GET	Get related fields data (saved-query-related-column-name)	/api/v1/saved_query/related/{column_name}

Datasources (1 endpoints) — Query datasource metadata and column values.

Method	Endpoint	Description
GET	Get possible values for a datasource column	/api/v1/datasource/{datasource_type}/{datasource_id}/column/{column_name}/values/

Advanced Data Type (2 endpoints) — Endpoints for advanced data type operations and conversions.

Method	Endpoint	Description
GET	Return an AdvancedDataTypeResponse	/api/v1/advanced_data_type/convert
GET	Return a list of available advanced data types	/api/v1/advanced_data_type/types

Organization & Customization

Tags (15 endpoints) — Organize assets with tags.

Method	Endpoint	Description
DELETE	Bulk delete tags	/api/v1/tag/
GET	Get a list of tags	/api/v1/tag/
POST	Create a tag	/api/v1/tag/
GET	Get metadata information about tag API endpoints	/api/v1/tag/_info
POST	Add tags to an object	/api/v1/tag/{object_type}/{object_id}/
DELETE	Delete a tagged object	/api/v1/tag/{object_type}/{object_id}/{tag}/
DELETE	Delete a tag	/api/v1/tag/{pk}
GET	Get a tag detail information	/api/v1/tag/{pk}
PUT	Update a tag	/api/v1/tag/{pk}
DELETE	Delete tag by pk favorites	/api/v1/tag/{pk}/favorites/
POST	Create tag by pk favorites	/api/v1/tag/{pk}/favorites/
POST	Bulk create tags and tagged objects	/api/v1/tag/bulk_create
GET	Get tag favorite status	/api/v1/tag/favorite_status/
GET	Get all objects associated with a tag	/api/v1/tag/get_objects/
GET	Get related fields data (tag-related-column-name)	/api/v1/tag/related/{column_name}

Annotation Layers (14 endpoints) — Manage annotation layers and annotations for charts.

Method	Endpoint	Description
DELETE	Delete multiple annotation layers in a bulk operation	/api/v1/annotation_layer/
GET	Get a list of annotation layers (annotation-layer)	/api/v1/annotation_layer/
POST	Create an annotation layer (annotation-layer)	/api/v1/annotation_layer/
GET	Get metadata information about this API resource (annotation-layer--info)	/api/v1/annotation_layer/_info
DELETE	Delete annotation layer (annotation-layer-pk)	/api/v1/annotation_layer/{pk}
GET	Get an annotation layer (annotation-layer-pk)	/api/v1/annotation_layer/{pk}
PUT	Update an annotation layer (annotation-layer-pk)	/api/v1/annotation_layer/{pk}
DELETE	Bulk delete annotation layers	/api/v1/annotation_layer/{pk}/annotation/
GET	Get a list of annotation layers (annotation-layer-pk-annotation)	/api/v1/annotation_layer/{pk}/annotation/
POST	Create an annotation layer (annotation-layer-pk-annotation)	/api/v1/annotation_layer/{pk}/annotation/
DELETE	Delete annotation layer (annotation-layer-pk-annotation-annotation-id)	/api/v1/annotation_layer/{pk}/annotation/{annotation_id}
GET	Get an annotation layer (annotation-layer-pk-annotation-annotation-id)	/api/v1/annotation_layer/{pk}/annotation/{annotation_id}
PUT	Update an annotation layer (annotation-layer-pk-annotation-annotation-id)	/api/v1/annotation_layer/{pk}/annotation/{annotation_id}
GET	Get 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.

Method	Endpoint	Description
DELETE	Bulk delete CSS templates	/api/v1/css_template/
GET	Get a list of CSS templates	/api/v1/css_template/
POST	Create a CSS template	/api/v1/css_template/
GET	Get metadata information about this API resource (css-template--info)	/api/v1/css_template/_info
DELETE	Delete a CSS template	/api/v1/css_template/{pk}
GET	Get a CSS template	/api/v1/css_template/{pk}
PUT	Update a CSS template	/api/v1/css_template/{pk}
GET	Get related fields data (css-template-related-column-name)	/api/v1/css_template/related/{column_name}

Sharing & Embedding

Dashboard Permanent Link (2 endpoints) — Create and retrieve permanent links to dashboard states.

Method	Endpoint	Description
POST	Create a new dashboard's permanent link	/api/v1/dashboard/{pk}/permalink
GET	Get dashboard's permanent link state	/api/v1/dashboard/permalink/{key}

Explore Permanent Link (2 endpoints) — Create and retrieve permanent links to chart explore states.

Method	Endpoint	Description
POST	Create a new permanent link (explore-permalink)	/api/v1/explore/permalink
GET	Get chart's permanent link state	/api/v1/explore/permalink/{key}

SQL Lab Permanent Link (2 endpoints) — Create and retrieve permanent links to SQL Lab states.

Method	Endpoint	Description
POST	Create a new permanent link (sqllab-permalink)	/api/v1/sqllab/permalink
GET	Get permanent link state for SQLLab editor.	/api/v1/sqllab/permalink/{key}

Embedded Dashboard (1 endpoints) — Configure embedded dashboard settings.

Method	Endpoint	Description
GET	Get a report schedule log (embedded-dashboard-uuid)	/api/v1/embedded_dashboard/{uuid}

Dashboard Filter State (4 endpoints) — Manage temporary filter state for dashboards.

Method	Endpoint	Description
POST	Create a dashboard's filter state	/api/v1/dashboard/{pk}/filter_state
DELETE	Delete a dashboard's filter state value	/api/v1/dashboard/{pk}/filter_state/{key}
GET	Get a dashboard's filter state value	/api/v1/dashboard/{pk}/filter_state/{key}
PUT	Update 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.

Method	Endpoint	Description
POST	Create a new form_data	/api/v1/explore/form_data
DELETE	Delete a form_data	/api/v1/explore/form_data/{key}
GET	Get a form_data	/api/v1/explore/form_data/{key}
PUT	Update an existing form_data	/api/v1/explore/form_data/{key}

Scheduling & Alerts

Report Schedules (11 endpoints) — Configure scheduled reports and alerts.

Method	Endpoint	Description
DELETE	Bulk delete report schedules	/api/v1/report/
GET	Get a list of report schedules	/api/v1/report/
POST	Create a report schedule	/api/v1/report/
GET	Get metadata information about this API resource (report--info)	/api/v1/report/_info
DELETE	Delete a report schedule	/api/v1/report/{pk}
GET	Get a report schedule	/api/v1/report/{pk}
PUT	Update a report schedule	/api/v1/report/{pk}
GET	Get a list of report schedule logs	/api/v1/report/{pk}/log/
GET	Get a report schedule log (report-pk-log-log-id)	/api/v1/report/{pk}/log/{log_id}
GET	Get related fields data (report-related-column-name)	/api/v1/report/related/{column_name}
GET	Get slack channels	/api/v1/report/slack_channels/

Security & Access Control

Security Roles (10 endpoints) — Manage security roles and their permissions.

Method	Endpoint	Description
GET	Get security roles	/api/v1/security/roles/
POST	Create security roles	/api/v1/security/roles/
GET	Get security roles info	/api/v1/security/roles/_info
DELETE	Delete security roles by pk	/api/v1/security/roles/{pk}
GET	Get security roles by pk	/api/v1/security/roles/{pk}
PUT	Update security roles by pk	/api/v1/security/roles/{pk}
POST	Create security roles by role_id permissions	/api/v1/security/roles/{role_id}/permissions
GET	Get security roles by role_id permissions	/api/v1/security/roles/{role_id}/permissions/
PUT	Update security roles by role_id users	/api/v1/security/roles/{role_id}/users
GET	List roles	/api/v1/security/roles/search/

Security Users (6 endpoints) — Manage user accounts.

Method	Endpoint	Description
GET	Get security users	/api/v1/security/users/
POST	Create security users	/api/v1/security/users/
GET	Get security users info	/api/v1/security/users/_info
DELETE	Delete security users by pk	/api/v1/security/users/{pk}
GET	Get security users by pk	/api/v1/security/users/{pk}
PUT	Update security users by pk	/api/v1/security/users/{pk}

Security Permissions (3 endpoints) — View available permissions.

Method	Endpoint	Description
GET	Get security permissions	/api/v1/security/permissions/
GET	Get security permissions info	/api/v1/security/permissions/_info
GET	Get security permissions by pk	/api/v1/security/permissions/{pk}

Security Resources (View Menus) (6 endpoints) — Manage security resources (view menus).

Method	Endpoint	Description
GET	Get security resources	/api/v1/security/resources/
POST	Create security resources	/api/v1/security/resources/
GET	Get security resources info	/api/v1/security/resources/_info
DELETE	Delete security resources by pk	/api/v1/security/resources/{pk}
GET	Get security resources by pk	/api/v1/security/resources/{pk}
PUT	Update security resources by pk	/api/v1/security/resources/{pk}

Security Permissions on Resources (View Menus) (6 endpoints) — Manage permission-resource mappings.

Method	Endpoint	Description
GET	Get security permissions resources	/api/v1/security/permissions-resources/
POST	Create security permissions resources	/api/v1/security/permissions-resources/
GET	Get security permissions resources info	/api/v1/security/permissions-resources/_info
DELETE	Delete security permissions resources by pk	/api/v1/security/permissions-resources/{pk}
GET	Get security permissions resources by pk	/api/v1/security/permissions-resources/{pk}
PUT	Update security permissions resources by pk	/api/v1/security/permissions-resources/{pk}

Row Level Security (8 endpoints) — Manage row-level security rules for data access control.

Method	Endpoint	Description
DELETE	Bulk delete RLS rules	/api/v1/rowlevelsecurity/
GET	Get a list of RLS	/api/v1/rowlevelsecurity/
POST	Create a new RLS rule	/api/v1/rowlevelsecurity/
GET	Get metadata information about this API resource (rowlevelsecurity--info)	/api/v1/rowlevelsecurity/_info
DELETE	Delete an RLS	/api/v1/rowlevelsecurity/{pk}
GET	Get an RLS	/api/v1/rowlevelsecurity/{pk}
PUT	Update an RLS rule	/api/v1/rowlevelsecurity/{pk}
GET	Get 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 (dashboards, charts, databases).

Method	Endpoint	Description
GET	Export all assets	/api/v1/assets/export/
POST	Import multiple assets	/api/v1/assets/import/

CacheRestApi (1 endpoints) — Cache management and invalidation operations.

Method	Endpoint	Description
POST	Invalidate cache records and remove the database records	/api/v1/cachekey/invalidate

LogRestApi (4 endpoints) — Access audit logs and activity history.

Method	Endpoint	Description
GET	Get a list of logs	/api/v1/log/
POST	Create log	/api/v1/log/
GET	Get a log detail information	/api/v1/log/{pk}
GET	Get recent activity data for a user	/api/v1/log/recent_activity/

User & System

Current User (2 endpoints) — Get information about the currently authenticated user.

Method	Endpoint	Description
GET	Get the user object	/api/v1/me/
GET	Get the user roles	/api/v1/me/roles/

User (1 endpoints) — User profile and preferences.

Method	Endpoint	Description
GET	Get the user avatar	/api/v1/user/{user_id}/avatar.png

Menu (1 endpoints) — Get the Superset menu structure.

Method	Endpoint	Description
GET	Get menu	/api/v1/menu/

Available Domains (1 endpoints) — Get available domains for the Superset instance.

Method	Endpoint	Description
GET	Get all available domains	/api/v1/available_domains/

AsyncEventsRestApi (1 endpoints) — Real-time event streaming via Server-Sent Events (SSE).

Method	Endpoint	Description
GET	Read off of the Redis events stream	/api/v1/async_event/

OpenApi (1 endpoints) — Access the OpenAPI specification.

Method	Endpoint	Description
GET	Get api by version openapi	/api/{version}/_openapi

---

Additional Resources

• Superset REST API Blog Post
• Accessing APIs with Superset