Create a Databricks connection and store OAuth credentials

Learn more about the Create Databricks Connection and Store OAuth Credentials API used to create a Databricks connection configuration and store M2M OAuth credentials for Zero Copy Interaction Integration from Databricks.

Use the Create Databricks Connection to create a Databricks connection configuration and store the M2M OAuth service principal credentials in a single request. When the request succeeds, Reltio saves the connection configuration and returns a connectionId confirming that the credentials are stored.

HTTP method and endpoint

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

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

Replace {platformUrl} with your Reltio platform base URL and {tenantId} with your tenant ID.

The following table describes the endpoint path parameter.


Parameter	Type	Required	Description
`tenantId`	String	Yes	Unique identifier of the tenant where the Databricks connection is defined. Example: `ce5627DYnQ6abcD`

Request headers

The following request headers must be included.


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

Request body

The following table describes the request body parameters required to create the Databricks connection and store the OAuth credentials.


Parameter	Type	Required	Description	Accepted values / Default
`connectionName`	String	Yes	Unique name for the Databricks connection within the tenant.	Example: `databricks-connection-01`
`workspaceUrl`	String	Yes	HTTPS URL of the Databricks workspace.	Example: `https://adb-1234567890123456.7.azuredatabricks.net`
`warehouseId`	String	Yes	Identifier of the Databricks SQL Warehouse.	Example: `ab1c2d3ef5g6h7i8`
`clientId`	String	Yes	OAuth client ID of the Databricks service principal.	Example: `a1b2c3d4-e5f6-7890-abcd-ef1234567890`
`clientSecret`	String	Yes	OAuth client secret of the Databricks service principal.	Example: `your-client-secret`

Example request

Use the following example to see how a complete request is structured. Replace the sample values with the connection details and service principal credentials from your environment.

POST {platformUrl}/reltio/api/tenants/{tenantId}/interactions/database-configs/databricks/oauth/credentials
{
  "connectionName": "databricks-connection-01",
  "workspaceUrl": "https://adb-1234567890123456.7.azuredatabricks.net",
  "warehouseId": "ab1c2d3ef5g6h7i8",
  "clientId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "clientSecret": "your-client-secret"
}

Response body

The following table describes the fields returned in the response body when the request succeeds.


Field	Type	Description
`successful`	Boolean	Indicates whether the request succeeded.
`result.connectionId`	String	Unique identifier of the saved Databricks connection configuration.
`result.connectionName`	String	Name of the Databricks connection configuration.
`result.message`	String	Confirmation message returned by the API.
`result.status`	String	Status of the operation.
`result.timestamp`	Number	Timestamp of the operation, in epoch milliseconds.

Example response

The following example shows a successful response.

{
  "successful": true,
  "result": {
    "connectionId": "f7956383-eb65-4298-b716-c6f808aa6744",
    "connectionName": "databricks-connection-01",
    "message": "Databricks M2M OAuth credentials stored successfully",
    "status": "success",
    "timestamp": 1779778867683
  }
}

Error codes and recommended actions

The following table lists the possible error responses returned by this API.


HTTP status	Description	Recommended action
`400 Bad Request`	An active Databricks connection already exists for the tenant.	Delete or revoke the existing connection before creating a new one.
	A Databricks connection with the same name already exists for the tenant.	Choose a different connection name and resubmit the request.
	The `workspaceUrl` field is null or empty.	Provide a valid Databricks workspace URL and resubmit the request.
	The `warehouseId` field is null or empty.	Provide a valid Databricks SQL Warehouse ID and resubmit the request.
	The `clientId` or `clientSecret` field is null or empty.	Provide valid OAuth credentials for the Databricks service principal and resubmit the request.
	The `workspaceUrl` format is invalid.	Correct the workspace URL format and resubmit the request.

Unify and manage your data