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's group_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
(Immutable) The table format in which you want to sync your tables. Valid values are ICEBERG and DELTA_LAKE
Authentication type
AWS secret access key to access the S3 bucket and AWS Glue
Catalog name
Should maintain tables in Databricks
HTTP path
OAuth 2.0 secret
ARN of the role which you created with different required policy mentioned in our setup guide
Snapshots older than the retention period are deleted every week. Default value: ONE_WEEK.
Server host name
(Immutable) Prefix path of the bucket for which you have configured access policy. It is not required if access has been granted to entire Bucket in the access policy
(Immutable) The name of the bucket to be used as destination
AWS access key to access the S3 bucket and AWS Glue
Server port number
Databricks Connection method. Default value: Directly.
OAuth 2.0 client ID
Region of your AWS S3 bucket
We use PrivateLink by default if your s3 bucket is in the same region as Fivetran. Turning on this toggle ensures that Fivetran always connects to s3 bucket over PrivateLink. Learn more in our PrivateLink documentation.
Personal access token
POST /v1/destinations HTTP/1.1
Accept: application/json;version=2
Authorization: Basic REPLACE_BASIC_AUTH
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 1398
{
"group_id": "group_id",
"service": "new_s3_datalake",
"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": {
"table_format": "ICEBERG | DELTA_LAKE",
"auth_type": "PERSONAL_ACCESS_TOKEN | OAUTH2",
"aws_secret_access_key": "aws_secret_access_key",
"catalog": "test_catalog",
"should_maintain_tables_in_databricks": true,
"http_path": "sql/protocolv1/o/2873663545782684434-15262-272625-fives565",
"oauth2_secret": "string",
"fivetran_role_arn": "iam_role_arn",
"snapshot_retention_period": "RETAIN_ALL_SNAPSHOTS | ONE_DAY | ONE_WEEK | TWO_WEEKS | FOUR_WEEKS | SIX_WEEKS",
"server_host_name": "87a8z-3da23-3da8d-cloud.databricks.com",
"prefix_path": "s3_bucket_path_prefix",
"bucket": "s3_bucket_name",
"aws_access_key_id": "aws_access_key_id",
"port": 443,
"databricks_connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
"oauth2_client_id": "string",
"region": "s3_bucket_region",
"is_private_link_required": true,
"personal_access_token": "your_databricks_personal_access_token"
}
}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
(Immutable) The table format in which you want to sync your tables. Valid values are ICEBERG and DELTA_LAKE
Authentication type
AWS secret access key to access the S3 bucket and AWS Glue
Catalog name
Should maintain tables in Databricks
HTTP path
OAuth 2.0 secret
ARN of the role which you created with different required policy mentioned in our setup guide
Snapshots older than the retention period are deleted every week. Default value: ONE_WEEK.
Server host name
(Immutable) Prefix path of the bucket for which you have configured access policy. It is not required if access has been granted to entire Bucket in the access policy
(Immutable) The name of the bucket to be used as destination
AWS access key to access the S3 bucket and AWS Glue
Server port number
Databricks Connection method. Default value: Directly.
OAuth 2.0 client ID
Region of your AWS S3 bucket
We use PrivateLink by default if your s3 bucket is in the same region as Fivetran. Turning on this toggle ensures that Fivetran always connects to s3 bucket over PrivateLink. Learn more in our PrivateLink documentation.
Personal access token
{
"code": "Created",
"message": "Operation performed.",
"data": {
"id": "destination_id",
"service": "new_s3_datalake",
"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": {
"table_format": "ICEBERG | DELTA_LAKE",
"auth_type": "PERSONAL_ACCESS_TOKEN | OAUTH2",
"aws_secret_access_key": "aws_secret_access_key",
"catalog": "test_catalog",
"should_maintain_tables_in_databricks": true,
"http_path": "sql/protocolv1/o/2873663545782684434-15262-272625-fives565",
"oauth2_secret": "string",
"fivetran_role_arn": "iam_role_arn",
"snapshot_retention_period": "RETAIN_ALL_SNAPSHOTS | ONE_DAY | ONE_WEEK | TWO_WEEKS | FOUR_WEEKS | SIX_WEEKS",
"server_host_name": "87a8z-3da23-3da8d-cloud.databricks.com",
"prefix_path": "s3_bucket_path_prefix",
"bucket": "s3_bucket_name",
"aws_access_key_id": "aws_access_key_id",
"port": 443,
"databricks_connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
"oauth2_client_id": "string",
"region": "s3_bucket_region",
"is_private_link_required": true,
"personal_access_token": "your_databricks_personal_access_token"
}
}
}