Destination Configlink
The destination setup configuration (config field) is different for each destination.
We will continue to add more destinations to this list throughout BETA:
- Azure Synapse
- BigQuery
- Databricks on AWS
- Databricks on Azure
- MySQL
- MySQL RDS
- MySQL Aurora RDS
- Panoply
- Periscope
- PostgreSQL
- PostgreSQL RDS
- PostgreSQL Amazon Aurora
- PostgreSQL Google Cloud
- Redshift
- Snowflake
- SQL Azure Database
- SQL Server
- SQL Server RDS
Azure Synapselink
Requestlink
POST 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",
"connection_type": "SSHTunnel",
"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 | |
connection_type |
Connection method. Default value: Directly. |
Directly, SSHTunnel |
tunnel_host |
SSH server name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_port |
SSH server port name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_user |
SSH user name. Must be populated if connection_type is set to SSHTunnel. |
For more information see also our Azure Synapse Setup Guide
BigQuerylink
Requestlink
POST 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"
}
}
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. |
For more information see also our BigQuery Setup Guide
Databricks on AWSlink
Requestlink
POST api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "databricks_aws",
"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",
"personal_access_token": "7sjhds-6273y2-h2y3uy-23782h-123hhs5",
"create_external_tables" : true,
"external_location": "/some_external_location"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
server_host_name (required) |
Server name | |
port (required) |
Server port number | |
http_path (required) |
HTTP path | |
personal_access_token (required) |
Personal access token | |
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. |
For more information, see our Databricks setup guide.
Databricks on Azurelink
Requestlink
POST api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "databricks_azure",
"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",
"personal_access_token": "7sjhds-6273y2-h2y3uy-23782h-123hhs5",
"create_external_tables" : true,
"external_location": "/some_external_location"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
server_host_name (required) |
Server name | |
port (required) |
Server port number | |
http_path (required) |
HTTP path | |
personal_access_token (required) |
Personal access token | |
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. |
For more information, see our Databricks setup guide
MySQLlink
Requestlink
POST 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",
"connection_type": "SSHTunnel",
"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 | |
connection_type |
Connection method. Default value: Directly. |
Directly, SSHTunnel |
tunnel_host |
SSH server name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_port |
SSH server port name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_user |
SSH user name. Must be populated if connection_type is set to SSHTunnel. |
For more information see also our MySQL RDS Setup Guide
MySQL RDSlink
Requestlink
POST 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",
"connection_type": "SSHTunnel",
"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 | |
connection_type |
Connection method. Default value: Directly. |
Directly, SSHTunnel |
tunnel_host |
SSH server name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_port |
SSH server port name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_user |
SSH user name. Must be populated if connection_type is set to SSHTunnel. |
For more information see also our MySQL RDS Setup Guide
MySQL Aurora RDSlink
Requestlink
POST 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",
"connection_type": "SSHTunnel",
"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 | |
connection_type |
Connection method. Default value: Directly. |
Directly, SSHTunnel |
tunnel_host |
SSH server name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_port |
SSH server port name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_user |
SSH user name. Must be populated if connection_type is set to SSHTunnel. |
For more information see also our Aurora RDS Setup Guide
Panoplylink
Requestlink
POST api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "panoply",
"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",
"connection_type": "SSHTunnel",
"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 | |
connection_type |
Connection method. Default value: Directly. |
Directly, SSHTunnel |
tunnel_host |
SSH server name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_port |
SSH server port name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_user |
SSH user name. Must be populated if connection_type is set to SSHTunnel. |
For more information see also our Panoply Setup Guide
Periscopelink
Requestlink
POST api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "periscope_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",
"connection_type": "SSHTunnel",
"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 | |
connection_type |
Connection method. Default value: Directly. |
Directly, SSHTunnel |
tunnel_host |
SSH server name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_port |
SSH server port name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_user |
SSH user name. Must be populated if connection_type is set to SSHTunnel. |
For more information see also our Periscope Setup Guide
PostgreSQLlink
Requestlink
POST 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",
"connection_type": "SSHTunnel",
"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 | |
connection_type |
Connection method. Default value: Directly. |
Directly, SSHTunnel |
tunnel_host |
SSH server name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_port |
SSH server port name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_user |
SSH user name. Must be populated if connection_type is set to SSHTunnel. |
For more information see also our Generic PostgreSQL Setup Guide
PostgreSQL RDSlink
Requestlink
POST 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",
"connection_type": "SSHTunnel",
"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 | |
connection_type |
Connection method. Default value: Directly. |
Directly, SSHTunnel |
tunnel_host |
SSH server name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_port |
SSH server port name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_user |
SSH user name. Must be populated if connection_type is set to SSHTunnel. |
For more information see also our PostgreSQL RDS Setup Guide
PostgreSQL Amazon Auroralink
Requestlink
POST 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",
"connection_type": "SSHTunnel",
"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 | |
connection_type |
Connection method. Default value: Directly. |
Directly, SSHTunnel |
tunnel_host |
SSH server name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_port |
SSH server port name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_user |
SSH user name. Must be populated if connection_type is set to SSHTunnel. |
For more information see also our Amazon Aurora PostgreSQL Setup Guide
PostgreSQL Google Cloudlink
Requestlink
POST 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",
"connection_type": "SSHTunnel",
"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 | |
connection_type |
Connection method. Default value: Directly. |
Directly, SSHTunnel |
tunnel_host |
SSH server name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_port |
SSH server port name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_user |
SSH user name. Must be populated if connection_type is set to SSHTunnel. |
For more information see also our Google Cloud PostgreSQL Setup Guide
Redshiftlink
Request for password authenticationlink
POST 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",
"connection_type": "SSHTunnel",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran"
}
}
Request for IAM authenticationlink
POST 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",
"connection_type": "SSHTunnel",
"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 | |
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. |
|
connection_type |
Connection method. Default value: Directly. |
Directly, SSHTunnel |
tunnel_host |
SSH server name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_port |
SSH server port name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_user |
SSH user name. Must be populated if connection_type is set to SSHTunnel. |
For more information see also our Redshift Setup Guide
Snowflakelink
Requestlink
POST 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"
}
}
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. |
For more information see also our Snowflake Setup Guide
Azure SQL Databaselink
Requestlink
POST 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",
"connection_type": "SSHTunnel",
"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 | |
connection_type |
Connection method. Default value: Directly. |
Directly, SSHTunnel |
tunnel_host |
SSH server name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_port |
SSH server port name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_user |
SSH user name. Must be populated if connection_type is set to SSHTunnel. |
For more information see also our Azure SQL Database Setup Guide
Generic SQL Serverlink
Requestlink
POST 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",
"connection_type": "SSHTunnel",
"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 | |
connection_type |
Connection method. Default value: Directly. |
Directly, SSHTunnel |
tunnel_host |
SSH server name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_port |
SSH server port name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_user |
SSH user name. Must be populated if connection_type is set to SSHTunnel. |
For more information see also our Generic SQL Server Setup Guide
SQL Server RDSlink
Requestlink
POST 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",
"connection_type": "SSHTunnel",
"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 | |
connection_type |
Connection method. Default value: Directly. |
Directly, SSHTunnel |
tunnel_host |
SSH server name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_port |
SSH server port name. Must be populated if connection_type is set to SSHTunnel. |
|
tunnel_user |
SSH user name. Must be populated if connection_type is set to SSHTunnel. |
For more information see also our SQL Server RDS Setup Guide