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

Changes

Changed in 3 of the 16 revisions of this API.26

  • dcf9b45503875See the full diff
    • ○

      added the new optional request property federation_audience

      new-optional-request-property

    • ○

      added the new optional request property service_principal_client_id

      new-optional-request-property

    • ○

      added the optional property federation_audience to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property federation_ready to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property service_principal_client_id to the response with the 200 status

      response-optional-property-added

  • 5ebc654175d42See the full diff
    • ●

      removed the request property account_id

      request-property-removed

    • ●

      removed the optional property account_id from the response with the 200 status

      response-optional-property-removed

  • b834704078071See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog