Test a Databricks connection

Learn more about testing a Databricks connection configured in Reltio.

After creating a Databricks connection, test it to verify that Reltio can connect to the configured SQL warehouse using the stored OAuth credentials. Reltio initially saves the connection with PENDING status. When the test succeeds and result.connected is true, Reltio changes the connection status to ACTIVE.

Note: This operation returns HTTP 200 OK for both successful and unsuccessful connection tests. Check result.connected to determine whether the connection succeeded.

HTTP method and endpoint

Use the following HTTP method and endpoint path to test the Databricks connection. In this endpoint, test is the fixed action segment used to validate the saved Databricks connection configuration.

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

The following table describes the endpoint path parameters.


Parameter	Type	Required	Description
`tenantId`	String	Yes	Unique identifier of the tenant where the Databricks connection is defined. Example: ce5627DYnQ6abcD
`connectionName`	String	Yes	Name of the existing Databricks connection configuration that you want to test.

Request headers

The following request headers must be included.


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

Request body

This operation does not require a request body.

Example request

Use the following example to test the Databricks connection configuration.

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

Response body

The following table describes the response fields returned by this operation.


Field	Type	Description
`successful`	Boolean	Indicates whether the request was processed. This value is `true` even when the connection test fails.
`result.connected`	Boolean	Indicates whether the Databricks connection test succeeded.
`result.databaseType`	String	Database type of the tested connection.
`result.message`	String	Result message returned by the connection test.

Example response

This operation returns HTTP 200 OK for both successful and unsuccessful tests. Check the result.connected field to determine whether the Databricks connection is valid.

If the connection test succeeds, the response is similar to the following example.

{
  "successful": true,
  "result": {
    "connected": true,
    "databaseType": "DATABRICKS",
    "message": "Connection successful"
  }
}

If the connection test fails, the response is similar to the following example. Review the response message to identify the issue, update the values saved through Create a Databricks connection and store OAuth credentials as needed, and then test the connection again.

{
  "successful": true,
  "result": {
    "connected": false,
    "databaseType": "DATABRICKS",
    "message": "Connection failed: <reason returned by Databricks>"
  }
}

Error codes and recommended actions

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


HTTP status	Description	Recommended action
`404 Not Found`	Configuration not found for the provided connection name.	Confirm `connectionName` and test the connection again.
`403 Forbidden`	Zero-copy is not enabled for the tenant.	Contact Reltio Support to enable the required zero-copy feature, then test again.

Unify and manage your data