Create destination
Creates a new destination within a specified group in your Fivetran account.
IMPORTANT: Groups and destinations are mapped 1:1 to each other. We do this mapping using the group's
id
value that we automatically generate when you create a group, and the destination'sgroup_id
value that you specify when you create a destination. This means that you must create a group in your Fivetran account before you can create a destination in it.
Request schema
Header parameters
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Request
The unique identifier for the group within the Fivetran system.
The name for the destination type within the Fivetran system.
Data processing location. This is where Fivetran will operate and run computation on data.
Determines the time zone for the Fivetran sync schedule.
Specifies whether we should trust the certificate automatically. The default value is FALSE. If a certificate is not trusted automatically, it has to be approved with Certificates Management API Approve a destination certificate.
Specifies whether we should trust the SSH fingerprint automatically. The default value is FALSE. If a fingerprint is not trusted automatically, it has to be approved with Certificates Management API Approve a destination fingerprint.
Specifies whether setup tests should be run automatically.
Shift my UTC offset with daylight savings time (US Only)
The unique identifier for the hybrid deployment agent within the Fivetran system
The unique identifier for the self-served private link that is used by the connection
The unique identifier for the proxy agent within the Fivetran system
Tenant ID of the service principal you created for Fivetran. Use this parameter only if you want to deploy your data lake on ADLS.
Specifies the authentication types for Fivetran to connect to Databricks. Use this parameter only if you want to use Unity Catalog to manage your Delta Lake tables.
Specifies whether you want to manage your Iceberg tables in AWS Glue. Use this parameter only if you want to deploy your data lake on AWS.
connection type
(Immutable) Name of your Azure Data Lake Storage Gen2 (ADLS Gen2) storage account. Use this parameter only if you want to deploy your data lake on ADLS.
Name of the specific catalog in Unity Catalog that you want to use to manage your Delta Lake tables. Use this parameter only if you want to use Unity Catalog with your data lake.
Specifies whether you want to manage your Delta Lake tables in Databricks Unity Catalog.
HTTP path of the Databricks account associated with Unity Catalog. Use this parameter only if you want to use Unity Catalog to manage your Delta Lake tables.
OAuth 2.0 secret you created for authenticating Fivetran. Use this parameter only if you want to use OAuth 2.0 as the authentication type for Fivetran to connect to Databricks.
(Immutable) ARN of the IAM role you created for the IAM policy associated with your S3 bucket or Glue catalog. Use this parameter only if you want to deploy your data lake on AWS.
Specifies how long you want us to retain your table snapshots. We delete the snapshots that are older than the retention period during our table maintenance operations. Default value: ONE_WEEK.
Server host name of the Databricks account associated with Unity Catalog. Use this parameter only if you want to use Unity Catalog to manage your Delta Lake tables.
Client ID of the service principal you created for Fivetran. Use this parameter only if you want to deploy your data lake on ADLS.
(Immutable) Prefix path or virtual folder path within your bucket or container where you want Fivetran to store your data. Skip this parameter for AWS-based data lakes if the IAM policy configured for your S3 bucket grants access to the entire bucket.
(Immutable) Name of the S3 or Google Cloud Storage (GCS) bucket you want to use to store your data. Use this parameter only if you want to deploy your data lake on Amazon Web Services (AWS) or GCS.
(Immutable) Name of the ADLS container you want to use to store your data. Use this parameter only if you want to deploy your data lake on ADLS.
Server port number of the Databricks account associated with Unity Catalog. Use this parameter only if you want to use Unity Catalog to manage your Delta Lake tables.
Specifies how you want Fivetran to connect to the Databricks account associated with Unity Catalog. Default value: Directly. Use this parameter only if you want to use Unity Catalog with your data lake.
Secret value of the service principal you created for Fivetran. Use this parameter only if you want to deploy your data lake on ADLS.
The cloud storage provider you want to use for your data lake.
(Immutable) AWS Region of your S3 bucket. Use this parameter only if you want to deploy your data lake on AWS.
The OAuth 2.0 client ID you created for authenticating Fivetran. Use this parameter only if you want to use OAuth 2.0 as the authentication type for Fivetran to connect to Databricks.
The personal access token you created for authenticating Fivetran. Use this parameter only if you want to use a personal access token as the authentication type for Fivetran to connect to Databricks.
POST /v1/destinations HTTP/1.1
Accept: application/json;version=2
Authorization: Basic <Replace with base64-encoded key>
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 1387
{
"group_id": "group_id",
"service": "managed_data_lake",
"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",
"should_maintain_tables_in_glue": true,
"connection_type": "Directly",
"storage_account_name": "adls_storage_account_name",
"catalog": "string",
"should_maintain_tables_in_databricks": true,
"http_path": "string",
"oauth2_secret": "string",
"fivetran_role_arn": "iam_role_arn",
"snapshot_retention_period": "ONE_WEEK",
"server_host_name": "string",
"client_id": "service_principal_client_id",
"prefix_path": "s3_bucket_path_prefix",
"bucket": "s3_bucket_name",
"container_name": "adls_container_name",
"port": 0,
"databricks_connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
"secret_value": "service_principal_secret_value",
"storage_provider": "AWS",
"region": "s3_bucket_region",
"oauth2_client_id": "string",
"personal_access_token": "string"
}
}
Responses
Successful response schema
Response status code
Response status text
The unique identifier for the destination within the Fivetran system
The name for the destination type within the Fivetran system.
Data processing location. This is where Fivetran will operate and run computation on data.
Destination setup status
Shift my UTC offset with daylight savings time (US Only)
The unique identifier for the group within the Fivetran system.
Determines the time zone for the Fivetran sync schedule.
Setup tests results for this destination
Setup test title
Setup test status
Setup test message
Setup test details
(Deprecated) The unique identifier for the hybrid deployment agent within the Fivetran system
The unique identifier for the self-served private link that is used by the connection
The unique identifier for the proxy agent within the Fivetran system
The unique identifier for the hybrid deployment agent within the Fivetran system
Tenant ID of the service principal you created for Fivetran. Use this parameter only if you want to deploy your data lake on ADLS.
Specifies the authentication types for Fivetran to connect to Databricks. Use this parameter only if you want to use Unity Catalog to manage your Delta Lake tables.
Specifies whether you want to manage your Iceberg tables in AWS Glue. Use this parameter only if you want to deploy your data lake on AWS.
connection type
(Immutable) Name of your Azure Data Lake Storage Gen2 (ADLS Gen2) storage account. Use this parameter only if you want to deploy your data lake on ADLS.
Name of the specific catalog in Unity Catalog that you want to use to manage your Delta Lake tables. Use this parameter only if you want to use Unity Catalog with your data lake.
Specifies whether you want to manage your Delta Lake tables in Databricks Unity Catalog.
HTTP path of the Databricks account associated with Unity Catalog. Use this parameter only if you want to use Unity Catalog to manage your Delta Lake tables.
OAuth 2.0 secret you created for authenticating Fivetran. Use this parameter only if you want to use OAuth 2.0 as the authentication type for Fivetran to connect to Databricks.
(Immutable) ARN of the IAM role you created for the IAM policy associated with your S3 bucket or Glue catalog. Use this parameter only if you want to deploy your data lake on AWS.
Specifies how long you want us to retain your table snapshots. We delete the snapshots that are older than the retention period during our table maintenance operations. Default value: ONE_WEEK.
Server host name of the Databricks account associated with Unity Catalog. Use this parameter only if you want to use Unity Catalog to manage your Delta Lake tables.
Client ID of the service principal you created for Fivetran. Use this parameter only if you want to deploy your data lake on ADLS.
(Immutable) Prefix path or virtual folder path within your bucket or container where you want Fivetran to store your data. Skip this parameter for AWS-based data lakes if the IAM policy configured for your S3 bucket grants access to the entire bucket.
(Immutable) Name of the S3 or Google Cloud Storage (GCS) bucket you want to use to store your data. Use this parameter only if you want to deploy your data lake on Amazon Web Services (AWS) or GCS.
(Immutable) Name of the ADLS container you want to use to store your data. Use this parameter only if you want to deploy your data lake on ADLS.
Server port number of the Databricks account associated with Unity Catalog. Use this parameter only if you want to use Unity Catalog to manage your Delta Lake tables.
Specifies how you want Fivetran to connect to the Databricks account associated with Unity Catalog. Default value: Directly. Use this parameter only if you want to use Unity Catalog with your data lake.
Secret value of the service principal you created for Fivetran. Use this parameter only if you want to deploy your data lake on ADLS.
The cloud storage provider you want to use for your data lake.
(Immutable) AWS Region of your S3 bucket. Use this parameter only if you want to deploy your data lake on AWS.
The OAuth 2.0 client ID you created for authenticating Fivetran. Use this parameter only if you want to use OAuth 2.0 as the authentication type for Fivetran to connect to Databricks.
The personal access token you created for authenticating Fivetran. Use this parameter only if you want to use a personal access token as the authentication type for Fivetran to connect to Databricks.
{
"code": "Created",
"message": "Operation performed.",
"data": {
"id": "destination_id",
"service": "managed_data_lake",
"region": "GCP_US_EAST4",
"networking_method": "Directly",
"setup_status": "CONNECTED",
"daylight_saving_time_enabled": true,
"group_id": "group_id",
"time_zone_offset": "+3",
"setup_tests": [
{
"title": "Test Title",
"status": "FAILED",
"message": "Test Message",
"details": "..."
}
],
"local_processing_agent_id": "local_processing_agent_id",
"private_link_id": "private_link_id",
"proxy_agent_id": "proxy_agent_id",
"hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
"config": {
"tenant_id": "service_principal_tenant_id",
"auth_type": "PERSONAL_ACCESS_TOKEN | OAUTH2",
"should_maintain_tables_in_glue": true,
"connection_type": "Directly",
"storage_account_name": "adls_storage_account_name",
"catalog": "string",
"should_maintain_tables_in_databricks": true,
"http_path": "string",
"oauth2_secret": "string",
"fivetran_role_arn": "iam_role_arn",
"snapshot_retention_period": "ONE_WEEK",
"server_host_name": "string",
"client_id": "service_principal_client_id",
"prefix_path": "s3_bucket_path_prefix",
"bucket": "s3_bucket_name",
"container_name": "adls_container_name",
"port": 0,
"databricks_connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
"secret_value": "service_principal_secret_value",
"storage_provider": "AWS",
"region": "s3_bucket_region",
"oauth2_client_id": "string",
"personal_access_token": "string"
}
}
}