Destination Config
The destination setup configuration (config field) is different for each destination. We will continue to add more destinations to this list:
- Azure Data Lake Storage
- Azure Synapse
- BigQuery
- ClickHouse Cloud
- Confluent Cloud
- Databricks
- Materialize
- MotherDuck
- MySQL
- Amazon RDS for MySQL
- MySQL Aurora RDS
- OneLake
- PostgreSQL
- Amazon RDS for PostgreSQL
- PostgreSQL Amazon Aurora
- PostgreSQL Google Cloud
- Propel
- Redshift
- S3 Data Lake
- SingleStore
- Snowflake
- SQL Azure Database
- SQL Server
- Amazon RDS for SQL Server
Azure Data Lake Storage
Request
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "adls",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"storage_account_name": "adls_storage_account_name",
"container_name": "adls_container_name",
"tenant_id": "service_principal_tenant_id",
"client_id": "service_principal_client_id",
"secret_value": "service_principal_secret_value",
"prefix_path": "adls_container_path_prefix",
"snapshot_retention_period": "ONE_WEEK",
"should_maintain_tables_in_databricks": true,
"catalog": "test_catalog",
"server_host_name": "adb-6366636321781.1.azuredatabricks.net",
"port": 443,
"http_path": "sql/1.0/warehouses/2873663545782684434-15262-272625-fives565",
"auth_type": "PERSONAL_ACCESS_TOKEN",
"personal_access_token": "your_databricks_personal_access_token"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
storage_account_name (required) | Azure Data Lake Storage account name. | |
container_name (required) | Azure Data Lake Storage container name. | |
tenant_id (required) | Service Principal tenant ID | |
client_id (required) | Service Principal client ID | |
secret_value (required) | Service Principal secret value | |
prefix_path | Path to data within your container. If not provided, by default, we will create a Fivetran folder in the root directory. | |
snapshot_retention_period (required) | Duration for which we should retain your table snapshots. We delete the snapshots older than the retention period. Default value: ONE_WEEK | RETAIN_ALL_SNAPSHOTS, ONE_WEEK, TWO_WEEKS, FOUR_WEEKS, SIX_WEEKS |
should_maintain_tables_in_databricks | Specifies whether we should migrate Delta Lake tables in Databricks. Default value: false | true, false |
catalog | Databricks Unity Catalog name. Required if should_maintain_tables_in_databricks is set to true. | |
server_host_name | Databricks server name. Required if should_maintain_tables_in_databricks is set to true. | |
port | Databricks server port number. Required if should_maintain_tables_in_databricks is set to true. | |
http_path | Databricks HTTP path. Required if should_maintain_tables_in_databricks is set to true. | |
auth_type | Authentication type for Databricks. Required if should_maintain_tables_in_databricks is set to true. | PERSONAL_ACCESS_TOKEN, OAUTH2 |
personal_access_token | Personal access token. Required if should_maintain_tables_in_databricks is set to true and auth_type is set to PERSONAL_ACCESS_TOKEN. | |
oauth2_client_id | OAuth 2.0 client ID. Required if should_maintain_tables_in_databricks is set to true and auth_type is set to OAUTH2. | |
oauth2_secret | OAuth 2.0 secret. Required if should_maintain_tables_in_databricks is set to true and auth_type is set to OAUTH2. |
For more information, see our Azure Data Lake Storage setup guide.
Azure Synapse
Request
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "azure_sql_data_warehouse",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"password": "fresh_air_267@83",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
user (required) | Database user name | |
password (required) | Database user password | |
tunnel_host | SSH server name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_port | SSH server port name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_user | SSH user name. Must be populated if networking_method is set to SshTunnel. |
For more information, see our Azure Synapse setup guide.
BigQuery
Request
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "big_query",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"project_id": "my-bigquery-project",
"data_set_location": "US",
"bucket": "customer-bucket",
"secret_key": "private-key-of-the-customer-service-account"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
project_id (required) | BigQuery project ID | |
data_set_location (required) | Data location. Datasets will reside in this location. | US, EU, us-west2, northamerica-northeast1, us-east4, southamerica-east1, europe-north1, europe-west2, europe-west6, asia-east2, asia-south1, asia-northeast2, asia-east1, asia-northeast1, asia-southeast1, australia-southeast1 |
bucket | Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location. | |
secret_key | Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account. |
For more information, see our BigQuery setup guide.
ClickHouse Cloud Partner-Built Private Preview
Request
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "clickhouse",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "my.service.clickhouse.cloud",
"port": 9440,
"username": "admin",
"password": "fresh_air_267@83"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
host (required) | The service hostname | |
port | The service port number | |
username (required) | The service username | |
password (required) | The service password |
For more information, see our ClickHouse Cloud setup guide.
Confluent Cloud
Request
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "confluent_cloud_wh",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"bootstrap_servers": ["serveraddress1:8080, serveraddress2:8080"],
"security_protocol": "SASL",
"sasl_mechanism": "PLAIN",
"sasl_plain_key": "your_API_key",
"sasl_plain_secret": "your_API_secret",
"num_of_partitions": 4,
"replication_factor": 3,
"data_format": "AVRO",
"schema_registry_url": "http://localhost:8088",
"schema_registry_api_key": "your_schema_registry_API_key",
"schema_registry_api_secret": "your_schema_registry_API_secret"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
bootstrap_servers | Comma-separated list of Confluent Cloud servers in the server:port format. | |
security_protocol | Security protocol for Confluent Cloud interaction. | SASL |
sasl_mechanism | Security protocol for Confluent Cloud interaction. | PLAIN |
sasl_plain_key | Confluent Cloud SASL key. | |
sasl_plain_secret | Confluent Cloud SASL secret. | |
num_of_partitions | Number of partitions per topic. | |
replication_factor | Replication factor. | 2, 3, 4 |
data_format | Confluent Cloud message format. | JSON, AVRO |
schema_registry_url | Schema registry URL. | |
schema_registry_api_key | Schema registry API key. | |
schema_registry_api_secret | Schema registry API secret. |
For more information, see our Confluent Cloud setup guide.
Databricks
Request for personal access token authentication
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "databricks",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"server_host_name": "87a8z-3da23-3da8d-cloud.databricks.com",
"port": 443,
"http_path": "sql/protocolv1/o/2873663545782684434-15262-272625-fives565",
"auth_type": "PERSONAL_ACCESS_TOKEN",
"personal_access_token": "your_databricks_personal_access_token",
"create_external_tables" : true,
"external_location": "/some_external_location",
"cloud_provider": "your_databricks_deployment_cloud"
}
}
Request for OAuth2.0 authentication
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "databricks",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"server_host_name": "87a8z-3da23-3da8d-cloud.databricks.com",
"port": 443,
"http_path": "sql/protocolv1/o/2873663545782684434-15262-272625-fives565",
"auth_type": "OAUTH2",
"oauth2_client_id": "your_oauth_client_id",
"oauth2_secret": "your_oauth_secret",
"create_external_tables" : true,
"external_location": "/some_external_location",
"cloud_provider": "your_databricks_deployment_cloud"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
server_host_name (required) | Server name | |
port (required) | Server port number | |
http_path (required) | HTTP path | |
auth_type (required) | Authentication type | PERSONAL_ACCESS_TOKEN, OAUTH2 |
personal_access_token | Personal access token. Required if auth_type is set to PERSONAL_ACCESS_TOKEN. | |
oauth2_client_id | OAuth 2.0 client ID. Required if auth_type is set to OAUTH2. | |
oauth2_secret | OAuth 2.0 secret. Required if auth_type is set to OAUTH2. | |
create_external_tables | Whether to create external tables | true, false |
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. | |
cloud_provider | Databricks deployment cloud | AWS, AZURE, GCP |
For more information, see our Databricks setup guide.
Materialize Partner-Built Private Preview
Request
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "materialize",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "wkshdjhwjdbjebjd.lb.us-east-1.aws.materialize.cloud",
"user": "admin",
"app_password": "fresh_air_267@83",
"dbname": "production",
"cluster": "my_cluster"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
host (required) | The hostname of your Materialize region | |
user (required) | The user to connect as | |
app_password (required) | The app password to authenticate with | |
dbname (required) | The name of the database to connect to | |
cluster | The cluster to run operations on |
For more information, see our Materialize setup guide.
MotherDuck Partner-Built Private Preview
Request
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "motherduck",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"motherduck_database": "production",
"motherduck_token": "yw876wyeih8yetug2ye6t28ueuy2wiehd2je",
"motherduck_csv_block_size": "1"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
motherduck_database (required) | The database to work in | |
motherduck_token (required) | The authentication token from app.motherduck.com | |
motherduck_csv_block_size | The CSV block size. This field limits the maximum length of a single field value coming from the input source. Must be a valid numeric value |
For more information, see our MotherDuck setup guide.
MySQL
Request
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "mysql_warehouse",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"password": "fresh_air_267@83",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran",
"always_encrypted": true
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
user (required) | Database user name | |
password (required) | Database user password | |
tunnel_host | SSH server name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_port | SSH server port name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_user | SSH user name. Must be populated if networking_method is set to SshTunnel. | |
always_encrypted | Specifies whether TLS is required. Must be populated if networking_method is set to SshTunnel. |
For more information, see our Amazon RDS for MySQL setup guide.
Amazon RDS for MySQL
Request
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "mysql_rds_warehouse",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"password": "fresh_air_267@83",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran",
"always_encrypted": true
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
user (required) | Database user name | |
password (required) | Database user password | |
tunnel_host | SSH server name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_port | SSH server port name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_user | SSH user name. Must be populated if networking_method is set to SshTunnel. | |
always_encrypted | Specifies whether TLS is required. Must be populated if networking_method is set to SshTunnel. |
For more information, see our Amazon RDS for MySQL setup guide.
MySQL Aurora RDS
Request
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "aurora_warehouse",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"password": "fresh_air_267@83",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran",
"always_encrypted": true
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
user (required) | Database user name | |
password (required) | Database user password | |
tunnel_host | SSH server name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_port | SSH server port name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_user | SSH user name. Must be populated if networking_method is set to SshTunnel. | |
always_encrypted | Specifies whether TLS is required. Must be populated if networking_method is set to SshTunnel. |
For more information, see our Aurora RDS setup guide.
OneLake
Request
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "onelake",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"workspace_guid": "onelake_workspace_guid",
"lakehouse_guid": "onelake_lakehouse_guid",
"tenant_id": "service_principal_tenant_id",
"client_id": "service_principal_client_id",
"secret_value": "service_principal_secret_value",
"snapshot_retention_period": "ONE_WEEK"
}
}
Config parameters
| Name | Description | Possible values |
|---|---|---|
workspace_guid (required) | OneLake workspace GUID | |
lakehouse_guid (required) | OneLake lakehouse GUID | |
tenant_id (required) | Service Principal tenant ID | |
client_id (required) | Service Principal client ID | |
secret_value (required) | Service Principal secret value | |
snapshot_retention_period (required) | Duration for which we should retain your table snapshots. We delete the snapshots older than the retention period. Default value: ONE_WEEK | RETAIN_ALL_SNAPSHOTS, ONE_WEEK, TWO_WEEKS, FOUR_WEEKS, SIX_WEEKS |
For more information, see our OneLake setup guide.
PostgreSQL
Request
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "postgres_warehouse",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"password": "fresh_air_267@83",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran",
"always_encrypted": true
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
user (required) | Database user name | |
password (required) | Database user password | |
tunnel_host | SSH server name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_port | SSH server port name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_user | SSH user name. Must be populated if networking_method is set to SshTunnel. | |
always_encrypted | Specifies whether TLS is required. Must be populated if networking_method is set to SshTunnel. |
For more information, see our Generic PostgreSQL setup guide.
Amazon RDS for PostgreSQL
Request
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "postgres_rds_warehouse",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"password": "fresh_air_267@83",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran",
"always_encrypted": true
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
user (required) | Database user name | |
password (required) | Database user password | |
tunnel_host | SSH server name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_port | SSH server port name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_user | SSH user name. Must be populated if networking_method is set to SshTunnel. | |
always_encrypted | Specifies whether TLS is required. Must be populated if networking_method is set to SshTunnel. |
For more information, see our Amazon RDS for PostgreSQL setup guide.
PostgreSQL Amazon Aurora
Request
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "aurora_postgres_warehouse",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"password": "fresh_air_267@83",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran",
"always_encrypted": true
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
user (required) | Database user name | |
password (required) | Database user password | |
tunnel_host | SSH server name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_port | SSH server port name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_user | SSH user name. Must be populated if networking_method is set to SshTunnel. | |
always_encrypted | Specifies whether TLS is required. Must be populated if networking_method is set to SshTunnel. |
For more information, see our Amazon Aurora PostgreSQL setup guide.
PostgreSQL Google Cloud
Request
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "postgres_gcp_warehouse",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"password": "fresh_air_267@83",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran",
"always_encrypted": true
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
user (required) | Database user name | |
password (required) | Database user password | |
tunnel_host | SSH server name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_port | SSH server port name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_user | SSH user name. Must be populated if networking_method is set to SshTunnel. | |
always_encrypted | Specifies whether TLS is required. Must be populated if networking_method is set to SshTunnel. |
For more information, see our Google Cloud PostgreSQL setup guide.
Propel Partner-Built Private Preview
Request
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "propel",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"clientId": "87a8z-3da23-3da8d-cloud.sql.com",
"clientSecret": "----secret----"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
clientId (required) | The application ID | |
clientSecret (required) | The application secret |
For more information, see our Propel setup guide.
Redshift
Request for password authentication
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "redshift",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"password": "fresh_air_267@83",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran"
}
}
Request for IAM authentication
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "redshift",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"auth_type": "IAM",
"role_arn": "arn:aws:iam::12345:role/test-role",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran",
"cluster_id": "clu5734-id",
"cluster_region": "us-east-1"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
user (required) | Database user name | |
auth_type | Authentication type. Default value: PASSWORD. | PASSWORD, IAM |
password | Database user password. Required if authentication type is PASSWORD. | |
role_arn | Role ARN with Redshift permissions. Required if authentication type is IAM. | |
tunnel_host | SSH server name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_port | SSH server port name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_user | SSH user name. Must be populated if networking_method is set to SshTunnel. | |
cluster_id | Cluster ID. Must be populated if networking_method is set to SshTunnel and auth_type is set to IAM. | |
cluster_region | Cluster region. Must be populated if networking_method is set to SshTunnel and auth_type is set to IAM. | For example, us-east-1, us-east-2, eu-west-2, ap-south-1. |
For more information, see our Redshift setup guide.
S3 Data Lake
Request
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "new_s3_datalake",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"bucket": "s3_bucket_name",
"fivetran_role_arn": "iam_role_arn",
"prefix_path": "s3_bucket_path_prefix",
"region": "s3_bucket_region",
"is_private_link_required" : false,
"table_format":"ICEBERG",
"snapshot_retention_period": "ONE_WEEK",
"should_maintain_tables_in_databricks": true,
"catalog": "test_catalog",
"server_host_name": "87a8z-3da23-3da8d-cloud.databricks.com",
"port": 443,
"http_path": "sql/protocolv1/o/2873663545782684434-15262-272625-fives565",
"auth_type": "PERSONAL_ACCESS_TOKEN",
"personal_access_token": "your_databricks_personal_access_token"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
bucket (required) | S3 bucket name | |
fivetran_role_arn (required) | ARN of the IAM role created to access the S3 bucket and AWS Glue | |
prefix_path | Path prefix of the S3 bucket. Must be populated if the access policy is configured for a specific bucket path. Not required if the access policy is configured for the entire bucket. | |
region (required) | AWS Region of the S3 bucket | |
is_private_link_required | Specified whether we should use always AWS PrivateLink to connect to your S3 bucket. By default, we use PrivateLink if your S3 bucket is in the same region as Fivetran. Default value: false | true, false |
table_format | The format of your destination tables. Default value: ICEBERG. | ICEBERG, DELTA_LAKE |
snapshot_retention_period (required) | Duration for which we should retain your table snapshots. We delete the snapshots older than the retention period. Default value: ONE_WEEK | RETAIN_ALL_SNAPSHOTS, ONE_WEEK, TWO_WEEKS, FOUR_WEEKS, SIX_WEEKS |
should_maintain_tables_in_databricks | Specifies whether we should migrate Delta Lake tables in Databricks. Default value: false | true, false |
catalog | Databricks Unity Catalog name. Required if should_maintain_tables_in_databricks is set to true. | |
server_host_name | Databricks server name. Required if should_maintain_tables_in_databricks is set to true. | |
port | Databricks server port number. Required if should_maintain_tables_in_databricks is set to true. | |
http_path | Databricks HTTP path. Required if should_maintain_tables_in_databricks is set to true. | |
auth_type | Authentication type for Databricks. Required if should_maintain_tables_in_databricks is set to true. | PERSONAL_ACCESS_TOKEN, OAUTH2 |
personal_access_token | Personal access token. Required if should_maintain_tables_in_databricks is set to true and auth_type is set to PERSONAL_ACCESS_TOKEN. | |
oauth2_client_id | OAuth 2.0 client ID. Required if should_maintain_tables_in_databricks is set to true and auth_type is set to OAUTH2. | |
oauth2_secret | OAuth 2.0 secret. Required if should_maintain_tables_in_databricks is set to true and auth_type is set to OAUTH2. |
For more information, see our S3 Data Lake setup guide.
SingleStore Partner-Built Private Preview
Request
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "singlestore",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "127.0.0.0",
"port": "3306",
"database": "production",
"user": "admin",
"password" : "12345",
"ssl.mode": "disable",
"ssl.server.cert": "---whdhegdgjbdjndjnfjndf=---",
"driver.parameters": "param1=value1;param2=value2;"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
host (required) | The hostname or IP address of the SingleStore workspace/cluster | |
Port (required) | The port of the SingleStore workspace/cluster | |
database | The SingleStore destination database in which data should be written. | |
user (required) | The username of the SingleStore database user | |
password | The password of the SingleStore database user | |
ssl.mode | This parameter defines whether an encrypted connection is used to connect to SingleStore. Possible values: - disable - to use an unencrypted connection (the default); - trust - to use a secure (encrypted) connection (no certificate and hostname validation); - verify_ca - to use a secure (encrypted) connection. In addition, the server TLS certificate against the configured Certificate Authority (CA) certificates. The connection fails if no valid matching CA certificates are found; - verify-full - to use a secure (encrypted) connection. In addition, the server TLS certificate is verified against the configured Certificate Authority (CA) certificates, and the server certificate is verified to match the host to which the connection is attempted. | disable, trust, verify_ca, verify-full |
ssl.server.cert | The server's certificate in DER format or the server's CA certificate. The certificate is added to the trust store, which allows the connection to trust a self-signed certificate. | |
driver.parameters | The additional JDBC parameters to use with connection string to SingleStore server. The format is as follows: param1=value1; param2 = value2; .... See the list of supported parameters. |
For more information, see our SingleStore setup guide.
Snowflake
Request
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "snowflake",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "your-account.snowflakecomputing.com",
"port": 443,
"database": "fivetran",
"auth": "PASSWORD",
"user": "fivetran_user",
"password": "123456",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran",
"always_encrypted": true
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
auth (required) | Password-based or key-based authentication type | PASSWORD, KEY_PAIR |
user (required) | Database user name | |
password | Database user password. The field should be specified if authentication type is PASSWORD. | |
private_key | Private access key. The field should be specified if authentication type is KEY_PAIR. | |
is_private_key_encrypted | Indicates that a private key is encrypted. The default value: false. The field can be specified if authentication type is KEY_PAIR. | true or false |
passphrase | In case private key is encrypted, you are required to enter passphrase that was used to encrypt the private key. The field can be specified if authentication type is KEY_PAIR. | |
tunnel_host | SSH server name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_port | SSH server port name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_user | SSH user name. Must be populated if networking_method is set to SshTunnel. | |
always_encrypted | Specifies whether TLS is required. Must be populated if networking_method is set to SshTunnel. |
For more information, see our Snowflake setup guide.
Azure SQL Database
Request
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "azure_sql_data_warehouse",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"password": "fresh_air_267@83",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran",
"always_encrypted": true
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
user (required) | Database user name | |
password (required) | Database user password | |
tunnel_host | SSH server name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_port | SSH server port name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_user | SSH user name. Must be populated if networking_method is set to SshTunnel. | |
always_encrypted | Specifies whether TLS is required. Must be populated if networking_method is set to SshTunnel. |
For more information, see our Azure SQL Database setup guide.
Generic SQL Server
Request
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "sql_server_warehouse",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"password": "fresh_air_267@83",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran",
"always_encrypted": true
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
user (required) | Database user name | |
password (required) | Database user password | |
tunnel_host | SSH server name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_port | SSH server port name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_user | SSH user name. Must be populated if networking_method is set to SshTunnel. | |
always_encrypted | Specifies whether TLS is required. Must be populated if networking_method is set to SshTunnel. |
For more information, see our Generic SQL Server setup guide.
Amazon RDS for SQL Server
Request
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "sql_server_rds_warehouse",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"password": "fresh_air_267@83",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran",
"always_encrypted": true
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
user (required) | Database user name | |
password (required) | Database user password | |
tunnel_host | SSH server name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_port | SSH server port name. Must be populated if networking_method is set to SshTunnel. | |
tunnel_user | SSH user name. Must be populated if networking_method is set to SshTunnel. | |
always_encrypted | Specifies whether TLS is required. Must be populated if networking_method is set to SshTunnel. |
For more information, see our Amazon RDS for SQL Server setup guide.