Use the following HTTP method and endpoint path to create the Databricks connection configuration.

POST {platformUrl}/reltio/api/tenants/{tenantId}/interactions/database-configs/

The following request headers must be included.

Header	Value	Required
Authorization	Bearer <access_token>	Yes
Content-Type	application/json	Yes

Use the request body to define the Databricks connection settings. The following table describes the supported request body parameters.

Parameter	Type	Required	Description	Accepted values / Default
connection_name	String	Yes	Unique name for the Databricks connection within the tenant.	Example: my-databricks-connection
database_type	String	Yes	Database type for the connection.	DATABRICKS
databricks_config.workspace.workspace_url	String	Yes	Full HTTPS URL of the Databricks workspace.	Example: https://adb-xxx.cloud.databricks.com
databricks_config.workspace.workspace_id	String	No	Databricks workspace identifier.	—
databricks_config.workspace.region	String	No	Region where the Databricks workspace is deployed.	Example: us-east-1
databricks_config.workspace.cloud_provider	String	No	Cloud provider for the Databricks workspace.	Example: AWS
databricks_config.sql_warehouse.warehouse_id	String	Yes	Databricks SQL Warehouse identifier.	Example: abc123def456
databricks_config.sql_warehouse.warehouse_name	String	No	Display name of the SQL Warehouse.	Example: my-warehouse
databricks_config.sql_warehouse.size	String	No	SQL Warehouse size value.	Example: SMALL
databricks_config.sql_warehouse.auto_stop	Boolean	No	Indicates whether the SQL Warehouse stops automatically after an idle period.	true or false
databricks_config.sql_warehouse.auto_stop_minutes	Integer	No	Idle time before auto-stop.	Example: 10
databricks_config.share_info.shared_catalog_name	String	Yes	Unity Catalog name that Reltio uses as the catalog for mapped Databricks tables or views.	Example: reltio_interactions
databricks_config.connection_properties.query_timeout	Integer	No	Query timeout setting for the connection.	Example: 300
databricks_config.connection_properties.max_pool_size	Integer	No	Maximum connection pool size for the Databricks connection.	Example: 5
databricks_config.auth_type	String	Yes	Authentication type used by the connection.	OAUTH_M2M

Use the following example to create a Databricks connection configuration. Replace the sample connection name, workspace values, warehouse values, shared catalog name, and connection properties with values from your environment.

POST {platformUrl}/reltio/api/tenants/{tenantId}/interactions/database-configs/
{
  "connection_name": "my-databricks-connection",
  "database_type": "DATABRICKS",
  "databricks_config": {
    "workspace": {
      "workspace_url": "https://adb-1234567890123456.7.azuredatabricks.net",
      "workspace_id": "1234567890123456",
      "region": "us-east-1",
      "cloud_provider": "AWS"
    },
    "sql_warehouse": {
      "warehouse_id": "abc123def456",
      "warehouse_name": "my-warehouse",
      "size": "SMALL",
      "auto_stop": true,
      "auto_stop_minutes": 10
    },
    "share_info": {
      "shared_catalog_name": "reltio_interactions"
    },
    "connection_properties": {
      "query_timeout": 300,
      "max_pool_size": 5
    },
    "auth_type": "OAUTH_M2M"
  }
}

The following table describes the successful response field returned by this operation.

Field	Type	Description
connectionId	String	Generated identifier of the saved Databricks connection configuration in Reltio.

If the request succeeds, this operation returns HTTP 201 Created with the created Databricks connection configuration, including the generated connectionId.

{
    "successful": true,
    "result": {
        "connection_id": "e1fc522f-8380-4177-98b9-acd63767d73b",
        "connection_name": "databricks-test-02",
        "tenant_id": "ZeroCopyDataBricks",
        "database_type": "DATABRICKS",
        "databricks_config": {
            "workspace": {
                "workspace_url": "https://reltio-ent-data-nile-aws-us-east-1-poc.cloud.databricks.com",
                "workspace_id": "892915033844773",
                "region": "us-east-1",
                "cloud_provider": "AWS"
            },
            "share_info": {
                "provider_share_identifier": "workspace-name.share-name",
                "shared_catalog_name": "reltio_interactions"
            },
            "sql_warehouse": {
                "warehouse_id": "af2d09b1051558ab",
                "size": "SMALL",
                "auto_stop": true,
                "auto_stop_minutes": 10
            },
            "connection_properties": {
                "queryTimeout": 120000,
                "maxPoolSize": 5
            },
            "auth_type": "OAUTH_M2M",
            "oauth_client_id": "100053d0-ca85-4975-8f2d-8110fe03fada"
        },
        "status": "PENDING",
        "created_time": "2026-04-09T13:03:23.033630458",
        "updated_time": "2026-04-09T13:03:23.033643419"
    }
}

If the request is invalid, the API returns a 400 Bad Request response. Review the error details, correct the request, and send the API request again.

{
    "successful": false,
    "error": "Code: DS_SNOWFLAKE_CONNECTION_ALREADY_EXISTS; Message parameters: [databricks-test-02, ZeroCopyDataBricks]. A Snowflake connection with this name already exists. A connection named databricks-test-02 already exists for tenant ZeroCopyDataBricks. Please choose a different name."
}