Databricks API Configuration

Request

POST https://api.fivetran.com/v1/destinations

{
  "group_id": "group_id",
  "service": "databricks",
  "region": "GCP_US_WEST1",
  "time_zone_offset": "+3",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "daylight_saving_time_enabled": true,
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "proxy_agent_id": "proxy_agent_id",
  "config": {
    "auth_type": "PERSONAL_ACCESS_TOKEN | OAUTH2",
    "create_external_tables": true,
    "storage_account_name": "string",
    "connection_type": "Directly | PrivateLink",
    "aws_secret_access_key": "string",
    "catalog": "string",
    "storage_account_key": "string",
    "cloud_provider": "AZURE | GCP | AWS",
    "http_path": "sql/protocolv1/o/2873663545782684434-15262-272625-fives565",
    "oauth2_secret": "your_oauth_secret",
    "server_host_name": "87a8z-3da23-3da8d-cloud.databricks.com",
    "s3_bucket_auth_type": "IAM_ROLE | IAM_USER",
    "bucket": "string",
    "external_storage_cloud_provider": "AZURE | GCP | AWS",
    "aws_access_key_id": "string",
    "disable_vacuum": true,
    "port": 443,
    "bucket_region": "string",
    "create_external_volumes": true,
    "azure_storage_account_auth_type": "Storage Account Key",
    "oauth2_client_id": "your_oauth_client_id",
    "external_volume_location": "s3://bucket/prefix_path",
    "personal_access_token": "your_databricks_personal_access_token",
    "external_location": "/some_external_location"
  }
}

Config parameters

Name	Description
`auth_type`	Authentication type
`create_external_tables`	Whether to create external tables
`storage_account_name`	Your storage account name
`connection_type`
`aws_secret_access_key`	Your user's secret access key
`catalog`	Catalog name
`storage_account_key`	Your storage account key
`cloud_provider`	Databricks deployment cloud
`http_path`	HTTP path
`oauth2_secret`	OAuth 2.0 secret
`server_host_name`	Server name
`s3_bucket_auth_type`	Authentication method for the S3 bucket you want to use as the external staging for Hybrid Deployment.
`bucket`	Your bucket
`external_storage_cloud_provider`
`aws_access_key_id`	Your user's access key ID
`disable_vacuum`	Specifies whether you want Fivetran to disable Vacuum operations on Delta tables.
`port`	Server port number
`bucket_region`	Your bucket's region
`create_external_volumes`	Specifies whether you want Fivetran to create external volumes for unstructured data files.
`azure_storage_account_auth_type`	Authentication method for the Azure container you want to use as the external staging for Hybrid Deployment.
`oauth2_client_id`	OAuth 2.0 client ID
`external_volume_location`	Specifies the external volume path where you want Fivetran to create the unstructured files.
`personal_access_token`	Personal access token
`external_location`	External location to store Delta tables. Default value: `""` (null). By default, the external tables will reside in the `/{schema}/{table}` path, and if you specify an external location in the `{externalLocation}/{schema}/{table}` path.