Skip to main content
Version: Next

Database

Manage database connections and metadata.

MethodEndpointPath
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}/
DELETEDelete a SSH tunnel/api/v1/database/{pk}/ssh_tunnel/
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/