OneLake API Configuration

Request

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

{
  "group_id": "group_id",
  "service": "onelake",
  "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": {
    "tenant_id": "service_principal_tenant_id",
    "auth_type": "PERSONAL_ACCESS_TOKEN | OAUTH2",
    "storage_account_name": "string",
    "catalog": "string",
    "should_maintain_tables_in_databricks": true,
    "http_path": "string",
    "oauth2_secret": "string",
    "snapshot_retention_period": "TWO_WEEKS | SIX_WEEKS | RETAIN_ALL_SNAPSHOTS | ONE_WEEK | FOUR_WEEKS | ONE_DAY",
    "server_host_name": "string",
    "client_id": "service_principal_client_id",
    "port": 0,
    "databricks_connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
    "secret_value": "service_principal_secret_value",
    "lakehouse_guid": "b63dbst-wj39-h8d4-i1f4-g24kg4ea67h3",
    "workspace_guid": "u2jdt6tr-t6ee-67t3-twn6-3gt7whundg64",
    "oauth2_client_id": "string",
    "personal_access_token": "string"
  }
}

Config parameters

Name	Description
`tenant_id`	Tenant ID of service principal
`auth_type`	Authentication type
`storage_account_name`	(Immutable) Storage account for Azure Data Lake Storage Gen2 name
`catalog`	Catalog name
`should_maintain_tables_in_databricks`	Should maintain tables in Databricks
`http_path`	HTTP path
`oauth2_secret`	OAuth 2.0 secret
`snapshot_retention_period`	Snapshots older than the retention period are deleted every week. Default value: `ONE_WEEK`.
`server_host_name`	Server Host name
`client_id`	Client ID of service principal
`port`	Server port number
`databricks_connection_type`	Databricks Connection method. Default value: `Directly`.
`secret_value`	Secret value for service principal
`lakehouse_guid`	(Immutable) OneLake lakehouse GUID
`workspace_guid`	(Immutable) OneLake workspace GUID
`oauth2_client_id`	OAuth 2.0 client ID
`personal_access_token`	Personal access token