API Configuration

You can manage your Databricks destination programmatically using the Weld REST API. This page covers the key operations specific to Databricks.

Authentication

All API requests require an API key passed via the x-api-key header. You can create API keys in Settings → API Keys inside the Weld app.

curl https://connect.weld.app/connections \
  --header 'x-api-key: YOUR_API_KEY'

Integration ID

When creating connections or syncs for Databricks, use the following integration ID:

ParameterValue
integration_iddatabricks

Create a Connection

To connect Databricks via the API, first create a connection bridge session:

curl https://connect.weld.app/connection_bridges \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY' \
  --data '{
  "integration_id": "databricks",
  "label": "databricks-production",
  "redirect_uri": "https://yourapp.com/callback"
}'

The response includes a URL to complete the OAuth flow. After authorization, the connection is available for creating ELT syncs.

Create an ELT Sync

Once a connection exists, create a sync to start loading data into Databricks:

curl https://connect.weld.app/elt_syncs \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY' \
  --data '{
  "connection_id": "YOUR_CONNECTION_ID",
  "destination_schema_name": "weld_production",
  "sync_interval": "0 */6 * * *"
}'

Manage Syncs

OperationMethodEndpoint
List syncsGET/elt_syncs
Get sync detailsGET/elt_syncs/{id}
Enable syncPOST/elt_syncs/{id}/enable
Disable syncPOST/elt_syncs/{id}/disable
Get sync statusGET/elt_syncs/{id}/status
Delete syncDELETE/elt_syncs/{id}

Manage Streams

OperationMethodEndpoint
List available streamsGET/elt_syncs/{id}/available_source_streams
Add streamsPOST/elt_syncs/{id}/source_streams
Trigger stream runPOST/elt_streams/{id}/request_run
Request full refreshPOST/elt_streams/{id}/request_full_refresh

Was this page helpful?