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

Destination type:

snowflake

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json;version=2

example:

application/json;version=2

Request

group_id

stringrequired

The unique identifier for the group within the Fivetran system.

example:

group_id

service

stringrequired

snowflake

The name for the destination type within the Fivetran system.

example:

snowflake

region

string

Data processing location. This is where Fivetran will operate and run computation on data.

enum:

"GCP_US_EAST4""GCP_US_WEST1""GCP_US_CENTRAL1""GCP_EUROPE_WEST3""GCP_AUSTRALIA_SOUTHEAST1""GCP_NORTHAMERICA_NORTHEAST1""GCP_EUROPE_WEST2""GCP_ASIA_SOUTHEAST1""GCP_ASIA_SOUTHEAST2""GCP_ASIA_SOUTH1""GCP_ASIA_NORTHEAST1""AWS_US_EAST_1""AWS_US_EAST_2""AWS_US_WEST_2""AWS_AP_NORTHEAST_1""AWS_AP_SOUTHEAST_1""AWS_AP_SOUTHEAST_2""AWS_EU_CENTRAL_1""AWS_EU_WEST_1""AWS_EU_WEST_2""AWS_AP_SOUTH_1""AWS_CA_CENTRAL_1""AWS_US_GOV_WEST_1""AZURE_EASTUS2""AZURE_AUSTRALIAEAST""AZURE_UKSOUTH""AZURE_WESTEUROPE""AZURE_CENTRALUS""AZURE_CANADACENTRAL""AZURE_UAENORTH""AZURE_SOUTHEASTASIA""AZURE_EASTUS""AZURE_JAPANEAST""AZURE_CENTRALINDIA"

time_zone_offset

stringrequired

Determines the time zone for the Fivetran sync schedule.

enum:

"-11""-10""-9""-8""-7""-6""-5""-4""-3""-2""-1""0""+1""+2""+3""+4""+5""+6""+7""+8""+9""+10""+11""+12"

trust_certificates

boolean

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.

example:

true

trust_fingerprints

boolean

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.

example:

true

run_setup_tests

boolean

Specifies whether setup tests should be run automatically.

example:

true

daylight_saving_time_enabled

boolean

Shift my UTC offset with daylight savings time (US Only)

example:

true

local_processing_agent_id

string

(Deprecated) The unique identifier for the hybrid deployment agent within the Fivetran system

example:

local_processing_agent_id

hybrid_deployment_agent_id

string

The unique identifier for the hybrid deployment agent within the Fivetran system

example:

hybrid_deployment_agent_id

private_link_id

string

The unique identifier for the self-served private link that is used by the connection

example:

private_link_id

networking_method

string

enum:

"Directly""PrivateLink""SshTunnel""ProxyAgent"

proxy_agent_id

string

The unique identifier for the proxy agent within the Fivetran system

example:

proxy_agent_id

config

object

role

string

If not specified, Fivetran will use the user's default role

example:

string

connection_type

object

Connection method. Default value: Directly.

enum:

"Directly""PrivateLink""SshTunnel""ProxyAgent"

auth

object

Password-based or key-based authentication type

enum:

"PASSWORD""KEY_PAIR""OAUTH"

private_key

string

Private access key. The field should be specified if authentication type is KEY_PAIR.

format:

password

example:

string

external_storage_integration

string

example:

string

database

string

Database name

example:

fivetran

password

string

Database user password. The field should be specified if authentication type is PASSWORD.

format:

password

example:

123456

is_private_key_encrypted

boolean

Indicates that a private key is encrypted. The default value: false. The field can be specified if authentication type is KEY_PAIR.

example:

true

port

integer

Server port number

format:

int32

example:

443

enable_external_storage_for_unstructured_files

boolean

example:

true

host

string

Server name

example:

your-account.snowflakecomputing.com

passphrase

string

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.

format:

password

example:

string

external_stage_storage_provider

object

enum:

"S3""AZURE""GCS""INTERNAL"

user

string

Database user name

example:

fivetran_user

external_storage_parent_folder_uri

string

example:

string

Http + 1.1

POST

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

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: 1103

{
  "group_id": "group_id",
  "service": "snowflake",
  "region": "GCP_US_WEST1",
  "time_zone_offset": "+3",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "daylight_saving_time_enabled": true,
  "local_processing_agent_id": "local_processing_agent_id",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "proxy_agent_id": "proxy_agent_id",
  "config": {
    "role": "string",
    "connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
    "auth": "KEY_PAIR | PASSWORD | OAUTH",
    "private_key": "string",
    "external_storage_integration": "string",
    "database": "fivetran",
    "password": "123456",
    "is_private_key_encrypted": true,
    "port": 443,
    "enable_external_storage_for_unstructured_files": true,
    "host": "your-account.snowflakecomputing.com",
    "passphrase": "string",
    "external_stage_storage_provider": "S3 | GCS | AZURE | INTERNAL",
    "user": "fivetran_user",
    "external_storage_parent_folder_uri": "string"
  }
}

Responses

201

Successful response

400

Bad request

404

Not found

Successful response schema

code

stringrequired

Response status code

example:

Created

message

string

Response status text

example:

Operation performed.

data

objectrequired

stringrequired

The unique identifier for the destination within the Fivetran system

example:

destination_id

service

stringrequired

snowflake

The name for the destination type within the Fivetran system.

example:

snowflake

region

stringrequired

Data processing location. This is where Fivetran will operate and run computation on data.

enum:

networking_method

string

enum:

"Directly""PrivateLink""SshTunnel""ProxyAgent"

setup_status

stringrequired

Destination setup status

enum:

"INCOMPLETE""CONNECTED""BROKEN"

daylight_saving_time_enabled

boolean

Shift my UTC offset with daylight savings time (US Only)

example:

true

group_id

stringrequired

The unique identifier for the group within the Fivetran system.

example:

group_id

time_zone_offset

stringrequired

Determines the time zone for the Fivetran sync schedule.

enum:

"-11""-10""-9""-8""-7""-6""-5""-4""-3""-2""-1""0""+1""+2""+3""+4""+5""+6""+7""+8""+9""+10""+11""+12"

setup_tests

array

Setup tests results for this destination

title

stringrequired

Setup test title

example:

Test Title

status

stringrequired

Setup test status

enum:

"PASSED""SKIPPED""WARNING""FAILED""JOB_FAILED"

message

string

Setup test message

example:

Test Message

details

object

Setup test details

example:

...

local_processing_agent_id

string

(Deprecated) The unique identifier for the hybrid deployment agent within the Fivetran system

example:

local_processing_agent_id

private_link_id

string

The unique identifier for the self-served private link that is used by the connection

example:

private_link_id

proxy_agent_id

string

The unique identifier for the proxy agent within the Fivetran system

example:

proxy_agent_id

hybrid_deployment_agent_id

string

The unique identifier for the hybrid deployment agent within the Fivetran system

example:

hybrid_deployment_agent_id

config

object

role

string

If not specified, Fivetran will use the user's default role

example:

string

connection_type

object

Connection method. Default value: Directly.

enum:

"Directly""PrivateLink""SshTunnel""ProxyAgent"

auth

object

Password-based or key-based authentication type

enum:

"PASSWORD""KEY_PAIR""OAUTH"

private_key

string

Private access key. The field should be specified if authentication type is KEY_PAIR.

format:

password

example:

string

external_storage_integration

string

example:

string

database

string

Database name

example:

fivetran

password

string

Database user password. The field should be specified if authentication type is PASSWORD.

format:

password

example:

123456

is_private_key_encrypted

boolean

Indicates that a private key is encrypted. The default value: false. The field can be specified if authentication type is KEY_PAIR.

example:

true

port

integer

Server port number

format:

int32

example:

443

enable_external_storage_for_unstructured_files

boolean

example:

true

host

string

Server name

example:

your-account.snowflakecomputing.com

passphrase

string

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.

format:

password

example:

string

external_stage_storage_provider

object

enum:

"S3""AZURE""GCS""INTERNAL"

user

string

Database user name

example:

fivetran_user

external_storage_parent_folder_uri

string

example:

string

{
  "code": "Created",
  "message": "Operation performed.",
  "data": {
    "id": "destination_id",
    "service": "snowflake",
    "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": {
      "role": "string",
      "connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
      "auth": "KEY_PAIR | PASSWORD | OAUTH",
      "private_key": "string",
      "external_storage_integration": "string",
      "database": "fivetran",
      "password": "123456",
      "is_private_key_encrypted": true,
      "port": 443,
      "enable_external_storage_for_unstructured_files": true,
      "host": "your-account.snowflakecomputing.com",
      "passphrase": "string",
      "external_stage_storage_provider": "S3 | GCS | AZURE | INTERNAL",
      "user": "fivetran_user",
      "external_storage_parent_folder_uri": "string"
    }
  }
}