--- title: Create a Databricks integration account description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Databricks Integration --- > For the complete documentation index, see [llms.txt](https://docs.datadoghq.com/llms.txt). # Create a Databricks integration account{% #create-a-databricks-integration-account %} Copy pageCopied {% tab title="v2" %} **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------------------------------------ | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/integration-interfaces/databricks/accounts | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/integration-interfaces/databricks/accounts | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/integration-interfaces/databricks/accounts | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/integration-interfaces/databricks/accounts | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/integration-interfaces/databricks/accounts | | uk1.datadoghq.com | POST https://api.uk1.datadoghq.com/api/v2/integration-interfaces/databricks/accounts | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/integration-interfaces/databricks/accounts | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/integration-interfaces/databricks/accounts | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/integration-interfaces/databricks/accounts | ### Overview Create a Databricks integration account. This endpoint requires the `manage_integrations` permission. ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------------------------------------------ | ------------------------------------------------ | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | Data envelope for creating a Databricks integration account. | | data | attributes [*required*] | object | Writable attributes used to create a Databricks integration account. | | attributes | authentication [*required*] | | Authentication for creating the Databricks integration account. Exactly one method is set. Choosing `private_action_runner` leaves the `databricks-model-serving-metrics` dataflow unable to collect data. `bearer_token` is not available on creation: Databricks accepts it only on accounts that already use it, so it can only appear on read and update. | | authentication | | object | Databricks OAuth machine-to-machine authentication using a service principal. | | | auth_type [*required*] | enum | The authentication method type. Allowed enum values: `databricks_oauth` | | | azure_tenant_id | string | Microsoft Entra ID tenant of the service principal, for Azure Databricks workspaces. | | | client_id [*required*] | string | Client ID of the Databricks service principal. | | | client_secret [*required*] | string | Secret of the Databricks service principal. Generate it under User management > Service principals > Credentials & secrets in Databricks. | | authentication | | object | Private Action Runner authentication. The runner holds the Databricks credentials, so this method carries no secrets. | | | auth_type [*required*] | enum | The authentication method type. Allowed enum values: `private_action_runner` | | | connection_id [*required*] | uuid | Unique identifier of the Private Action Runner connection holding the credentials. | | | secret_path | string | Path of the credential inside the secret backend configured on the runner. | | | user_uuid [*required*] | uuid | Unique identifier of the user the Private Action Runner connection belongs to. | | attributes | dataflows | object | Data Datadog collects from Databricks, keyed by dataflow id. Each dataflow turns on a distinct kind of collection: set `enabled` to start or stop it, and use `settings` to configure what it collects. Defaults listed on each dataflow apply when the account is created; on update, omitted fields keep their current values. Some dataflows have prerequisites, noted on each; unless one is documented as rejecting the request, it is not verified, so a dataflow enabled without it is stored but collects no data. | | dataflows | databricks-cloud-cost-metrics | object | Cost data collected from your Databricks system tables. [Cloud Cost Management](https://docs.datadoghq.com/cloud_cost_management.md) must be enabled for your organization while this dataflow is on; any request that leaves it enabled without that is rejected with a `422` response. | | databricks-cloud-cost-metrics | enabled | boolean | Whether Datadog collects this data. Defaults to `false`; set to `true` to start collection. | | databricks-cloud-cost-metrics | settings | object | Settings of the Cloud Cost Management dataflow. Only the fields provided are changed. | | settings | ccm_collect_all_workspaces | boolean | Whether cost data is collected for every workspace in the Databricks account rather than this workspace only. This takes effect across the Databricks account: if any one workspace enables it, Datadog collects cost data for all of them regardless of their individual settings, and every covered workspace incurs Cloud Cost Management charges. Defaults to `true`. | | dataflows | databricks-data-observability-jobs-monitoring | object | Data Jobs Monitoring, which collects performance, reliability, and cost data for your Databricks jobs. | | databricks-data-observability-jobs-monitoring | enabled | boolean | Whether Datadog collects this data. Defaults to `true`; set to `false` to stop collection. | | databricks-data-observability-jobs-monitoring | settings | object | Settings of the Data Jobs Monitoring dataflow. Only the fields provided are changed. | | settings | dd_api_key_id | string | ID of the Datadog API key the global init script uses to submit data. Setting or changing it requires `dd_api_key_secret` in the same request. | | settings | dd_api_key_secret | string | Secret value of the Datadog API key identified by `dd_api_key_id`. | | settings | djm_global_init_script_enabled | boolean | Whether Datadog installs and manages the Agent on your Databricks clusters through a global init script. Installation can take up to 15 minutes and requires Databricks Workspace Admin permissions. The script does not apply to clusters in Standard access mode. Leave this `false` to install the Agent yourself. Defaults to `false`. | | settings | script_gpum_enabled | boolean | Whether GPU metrics are collected from your Databricks clusters. The Agent installed by the global init script performs the collection, so this requires the dataflow to be enabled with `djm_global_init_script_enabled` set to `true`. Defaults to `false`. | | settings | script_logs_enabled | boolean | Whether driver and worker logs are collected from your Databricks clusters. The Agent installed by the global init script performs the collection, so this requires the dataflow to be enabled with `djm_global_init_script_enabled` set to `true`. Defaults to `false`. | | settings | serverless_jobs_enabled | boolean | Whether health and cost data is collected for jobs running on Serverless or SQL Warehouse compute. This compute has no clusters for the global init script to target, so collection reads the Databricks system tables and requires `system_tables_sql_warehouse_id`. Defaults to `true`. | | dataflows | databricks-data-observability-quality-monitoring | object | Data Observability, which collects lineage and data quality information from your Databricks catalogs so you can explore how data flows and detect, resolve, and prevent quality issues. | | databricks-data-observability-quality-monitoring | enabled | boolean | Whether Datadog collects this data. Defaults to `false`; set to `true` to start collection. | | databricks-data-observability-quality-monitoring | settings | object | Settings of the Data Observability dataflow. Only the fields provided are changed. | | settings | do_crawlers_cron | string | Cron expression setting how often Datadog connects to your Databricks warehouse to collect metadata. Currently, only hourly (`0 * * * *`) and daily (`0 0 * * *`) are supported. Defaults to hourly (`0 * * * *`). | | settings | sync_system_catalog | boolean | Whether metadata from the Databricks `system` catalog is included in Data Observability alongside your data catalogs. Defaults to `false`. | | dataflows | databricks-model-serving-metrics | object | Health and usage metrics for your Databricks model serving endpoints. Not supported on accounts that authenticate with `private_action_runner`; on those accounts this dataflow collects no data. | | databricks-model-serving-metrics | enabled | boolean | Whether Datadog collects this data. Defaults to `false`; set to `true` to start collection. | | attributes | name [*required*] | string | Human-readable name of the Databricks integration account. | | attributes | settings [*required*] | object | Settings for creating the Databricks integration account. | | settings | system_tables_sql_warehouse_id | string | ID of the SQL warehouse used to query the Databricks system tables. Find it at the end of the HTTP Path under Warehouses > Connection Details in the Databricks console. Required when the cloud cost metrics or the Data Observability dataflow is enabled, or when `serverless_jobs_enabled` is on; since serverless jobs are on unless explicitly disabled, omitting this field otherwise causes the request to be rejected with a `422` response. | | settings | workspace_url [*required*] | string | URL of the Databricks workspace. | | data | type [*required*] | enum | The type of the integration account resource. Always `integration-account`. Allowed enum values: `integration-account` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "authentication": { "auth_type": "databricks_oauth", "azure_tenant_id": "4d3bac44-0230-4732-9e70-cc00736f0a97", "client_id": "5c10654a-b3a3-4840-b37f-f477590c70a0", "client_secret": "your-client-secret" }, "dataflows": { "databricks-cloud-cost-metrics": { "enabled": true, "settings": { "ccm_collect_all_workspaces": true } }, "databricks-data-observability-jobs-monitoring": { "enabled": true, "settings": { "dd_api_key_id": "fe383f4e-09fc-46bf-8e10-4efdd453a646", "dd_api_key_secret": "your-datadog-api-key", "djm_global_init_script_enabled": true, "script_gpum_enabled": true, "script_logs_enabled": true, "serverless_jobs_enabled": true } }, "databricks-data-observability-quality-monitoring": { "enabled": true, "settings": { "do_crawlers_cron": "0 * * * *", "sync_system_catalog": true } }, "databricks-model-serving-metrics": { "enabled": true } }, "name": "My Databricks Workspace", "settings": { "system_tables_sql_warehouse_id": "aba7c023d4172910", "workspace_url": "https://dbc-1234abcd.cloud.databricks.com" } }, "type": "integration-account" } } ``` {% /tab %} ### Response {% tab title="201" %} Created {% tab title="Model" %} Response payload for a single Databricks integration account. | Parent field | Field | Type | Description | | ------------------------------------------------ | ------------------------------------------------ | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | Data envelope of a Databricks integration account, including server-assigned identity. | | data | attributes [*required*] | object | Attributes of a Databricks integration account returned in responses. | | attributes | authentication | | Authentication configured on the Databricks integration account. A `bearer_token` method indicates an account still on token authentication, which Databricks accepts only on accounts that already use it. | | authentication | | object | The Databricks OAuth authentication method and service principal configured on the account. | | | auth_type [*required*] | enum | The authentication method type. Allowed enum values: `databricks_oauth` | | | azure_tenant_id | string | Microsoft Entra ID tenant of the service principal, for Azure Databricks workspaces. | | | client_id [*required*] | string | Client ID of the Databricks service principal. | | authentication | | object | The Private Action Runner authentication method configured on the account. | | | auth_type [*required*] | enum | The authentication method type. Allowed enum values: `private_action_runner` | | | connection_id [*required*] | string | Unique identifier of the Private Action Runner connection holding the credentials. | | | secret_path | string | Path of the credential inside the secret backend configured on the runner. | | | user_uuid [*required*] | string | Unique identifier of the user the Private Action Runner connection belongs to. | | authentication | | object | The bearer token authentication method configured on the account. | | | auth_type [*required*] | enum | The authentication method type. Allowed enum values: `bearer_token` | | attributes | dataflows | object | Data Datadog collects from Databricks, keyed by dataflow id. | | dataflows | databricks-cloud-cost-metrics | object | Cost data collected from your Databricks system tables. Requires [Cloud Cost Management](https://docs.datadoghq.com/cloud_cost_management.md) to be set up for your organization. | | databricks-cloud-cost-metrics | enabled | boolean | Whether Datadog collects this data. | | databricks-cloud-cost-metrics | settings | object | Settings of the Cloud Cost Management dataflow. | | settings | ccm_collect_all_workspaces | boolean | Whether cost data is collected for every workspace in the Databricks account rather than this workspace only. This takes effect across the Databricks account: if any one workspace enables it, Datadog collects cost data for all of them regardless of their individual settings, and every covered workspace incurs Cloud Cost Management charges. | | dataflows | databricks-data-observability-jobs-monitoring | object | Data Jobs Monitoring, which collects performance, reliability, and cost data for your Databricks jobs. | | databricks-data-observability-jobs-monitoring | enabled | boolean | Whether Datadog collects this data. | | databricks-data-observability-jobs-monitoring | settings | object | Settings of the Data Jobs Monitoring dataflow. | | settings | dd_api_key_id | string | ID of the Datadog API key the global init script uses to submit data. | | settings | djm_global_init_script_enabled | boolean | Whether Datadog installs and manages the Agent on your Databricks clusters through a global init script. The script does not apply to clusters in Standard access mode. When `false`, the Agent is installed manually. | | settings | script_gpum_enabled | boolean | Whether GPU metrics are collected from your Databricks clusters. The Agent installed by the global init script performs the collection, so this requires the dataflow to be enabled with `djm_global_init_script_enabled` set to `true`. | | settings | script_logs_enabled | boolean | Whether driver and worker logs are collected from your Databricks clusters. The Agent installed by the global init script performs the collection, so this requires the dataflow to be enabled with `djm_global_init_script_enabled` set to `true`. | | settings | serverless_jobs_enabled | boolean | Whether health and cost data is collected for jobs running on Serverless or SQL Warehouse compute. This compute has no clusters for the global init script to target, so collection reads the Databricks system tables and requires `system_tables_sql_warehouse_id`. | | dataflows | databricks-data-observability-quality-monitoring | object | Data Observability, which collects lineage and data quality information from your Databricks catalogs so you can explore how data flows and detect, resolve, and prevent quality issues. | | databricks-data-observability-quality-monitoring | enabled | boolean | Whether Datadog collects this data. | | databricks-data-observability-quality-monitoring | settings | object | Settings of the Data Observability dataflow. | | settings | do_crawlers_cron | string | Cron expression setting how often Datadog connects to your Databricks warehouse to collect metadata. Currently, only hourly (`0 * * * *`) and daily (`0 0 * * *`) are supported. | | settings | sync_system_catalog | boolean | Whether metadata from the Databricks `system` catalog is included in Data Observability alongside your data catalogs. | | dataflows | databricks-model-serving-metrics | object | Health and usage metrics for your Databricks model serving endpoints. Not supported on accounts that authenticate with `private_action_runner`; on those accounts this dataflow collects no data. | | databricks-model-serving-metrics | enabled | boolean | Whether Datadog collects this data. | | attributes | name [*required*] | string | Human-readable name of the Databricks integration account. | | attributes | settings [*required*] | object | Settings configured on the Databricks integration account. | | settings | system_tables_sql_warehouse_id | string | ID of the SQL warehouse used to query the Databricks system tables. | | settings | workspace_url [*required*] | string | URL of the Databricks workspace. | | data | id [*required*] | string | Server-generated unique identifier of the Databricks integration account. | | data | type [*required*] | enum | The type of the integration account resource. Always `integration-account`. Allowed enum values: `integration-account` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "authentication": { "auth_type": "databricks_oauth", "azure_tenant_id": "4d3bac44-0230-4732-9e70-cc00736f0a97", "client_id": "5c10654a-b3a3-4840-b37f-f477590c70a0" }, "dataflows": { "databricks-cloud-cost-metrics": { "enabled": true, "settings": { "ccm_collect_all_workspaces": true } }, "databricks-data-observability-jobs-monitoring": { "enabled": true, "settings": { "dd_api_key_id": "fe383f4e-09fc-46bf-8e10-4efdd453a646", "djm_global_init_script_enabled": true, "script_gpum_enabled": true, "script_logs_enabled": true, "serverless_jobs_enabled": true } }, "databricks-data-observability-quality-monitoring": { "enabled": true, "settings": { "do_crawlers_cron": "0 * * * *", "sync_system_catalog": true } }, "databricks-model-serving-metrics": { "enabled": true } }, "name": "My Databricks Workspace", "settings": { "system_tables_sql_warehouse_id": "aba7c023d4172910", "workspace_url": "https://dbc-1234abcd.cloud.databricks.com" } }, "id": "a9a69c2e-4f8d-4e42-9c1a-2a7a2d3b7c6f", "type": "integration-account" } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Not Found {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="422" %} The server cannot process the request because it contains invalid data. {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Curl command curl -X POST "https://api.datadoghq.com/api/v2/integration-interfaces/databricks/accounts" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "authentication": {}, "name": "My Databricks Workspace", "settings": { "workspace_url": "https://dbc-1234abcd.cloud.databricks.com" } }, "type": "integration-account" } } EOF {% /tab %}