Skip to main content

Home

Workspaces

Overview

Use the Workspaces List API to retrieve configured Databricks workspaces, including optional metadata such as cloud, tier, region, and monitoring settings.

Workspaces List API
Request
/api/v1/ds/api/v1/databricks/workspaces

This API returns all Databricks workspaces known to the system, keyed by workspace ID.

Query parameters

Parameter

Type

Description

metadata

boolean

When true, include extended workspace metadata fields.

Example
curl -X GET \
  -H "Authorization: JWT <token>" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  "https://{yourdomain.com}/api/v1/ds/api/v1/databricks/workspaces?metadata=true"
Response
{"674688609822":{"id":"674688609822","name":"prj2778928-674688609822-eu-west-1-prd","instance":"https://shell-prj2778928-674688609822-eu-west-1-prd.cloud.databricks.com","databricksAccountId":"prj2778928-674688609822-eu-west-1-prd","tier":"premium","region":"euwest1","platform":"aws","isComplianceEnabled":false,"monitorSQL":true,"uploadSensors":true,"uploadSensorsDisabled":false,"token":"AES(A88CFD1E6C111B17131430FC483496C9jtmp3N4m0n9+KX3mDG0nNhSigpj3j1dkyZiBf2AZ5t5aXnGAqovme9c1hDGPFWFP)","isTokenDecrypted":false,"authType":"pat","authIdp":null,"oauthTenantId":null,"oauthClientId":null,"oauthClientSecret":null,"oauthClientSecretName":null,"tokenSecretName":null},"6220801762796897":{"id":"6220801762796897","name":"AZAS-ADB-EX-N-SEQ00234-IM","instance":"https://adb-6220801762796897.17.azuredatabricks.net","tier":"standard","region":"northeurope","platform":"azure","isComplianceEnabled":false,"monitorSQL":false,"uploadSensors":true,"uploadSensorsDisabled":false,"token":"AES(733AC4C3C9C701B1EFBC28D9482B1A33n8pMi/QAcV2bzl07coyTLjGwna5b6QrDnQ2e4J5Xtx/MJdLrBCIviNpN53yqOqjQ)","isTokenDecrypted":false,"authType":"pat","authIdp":null,"oauthTenantId":null,"oauthClientId":null,"oauthClientSecret":null,"oauthClientSecretName":null,"tokenSecretName":null}}
In this section: