Sign in
databricks

Upsert Connection

Create or update the organization's Databricks connection.

put/api/databricks/connection

Request body

workspace_hoststring required
cloud'aws' | 'azure' | 'gcp' required

Cloud a Databricks workspace is hosted on.

Determines the account console host used for account-level OIDC, so it is persisted rather than inferred from the workspace hostname.

oauth_client_idstring required
oauth_client_secretstring nullable
oauth_redirect_uristring required
enabled_auth_modesstring[]
service_principal_client_idstring nullable
federation_audiencestring nullable

Response

Successful Response

configuredboolean required
workspace_hoststring nullable
workspace_idstring nullable
cloudstring nullable
oauth_client_idstring nullable
oauth_redirect_uristring nullable
has_client_secretboolean
enabled_auth_modesstring[]
service_principal_client_idstring nullable
federation_audiencestring nullable
federation_readyboolean
warehouse_idstring nullable
genie_agent_idstring nullable
default_catalogstring nullable
default_schemastring nullable
disabledboolean