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:

confluent_cloud_wh

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

confluent_cloud_wh

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"

config

object

schema_registry_api_secret

string

Schema registry API secret.

format:

password

example:

your_schema_registry_API_secret

schema_registry

object

Schema Registry

enum:

"AIVEN_KARAPACE""CONFLUENT_CLOUD""AWS_GLUE"

data_format

object

Confluent Cloud message format.

enum:

"JSON""AVRO"

replication_factor

integer

Replication factor.

format:

int32

example:

schema_registry_api_key

string

Schema registry API key.

format:

password

example:

your_schema_registry_API_key

sasl_plain_secret

string

Confluent Cloud SASL secret.

format:

password

example:

your_API_secret

bootstrap_servers

array

Comma-separated list of Confluent Cloud servers in the server:port format.

example:

string

type:

string

connection_method

object

enum:

"privatelink""direct"

schema_registry_url

string

Schema registry URL.

example:

http

enable_single_topic

boolean

Populate all tables in a single topic.

example:

true

sasl_plain_key

string

Confluent Cloud SASL key.

format:

password

example:

your_API_key

sasl_mechanism

object

Security protocol for Confluent Cloud interaction.

enum:

"PLAIN""SCRAM_SHA_512""SCRAM_SHA_256""AWS_IAM"

security_protocol

object

Security protocol for Confluent Cloud interaction.

enum:

"SASL""SASL_PLAINTEXT"

num_of_partitions

integer

Number of partitions per topic.

format:

int32

example:

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

{
  "group_id": "group_id",
  "service": "confluent_cloud_wh",
  "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",
  "config": {
    "schema_registry_api_secret": "your_schema_registry_API_secret",
    "schema_registry": "CONFLUENT_CLOUD | AWS_GLUE | AIVEN_KARAPACE",
    "data_format": "JSON | AVRO",
    "replication_factor": 3,
    "schema_registry_api_key": "your_schema_registry_API_key",
    "sasl_plain_secret": "your_API_secret",
    "bootstrap_servers": [
      "string"
    ],
    "connection_method": "direct | privatelink",
    "schema_registry_url": "http",
    "enable_single_topic": true,
    "sasl_plain_key": "your_API_key",
    "sasl_mechanism": "PLAIN | SCRAM_SHA_512 | SCRAM_SHA_256 | AWS_IAM",
    "security_protocol": "SASL | SASL_PLAINTEXT",
    "num_of_partitions": 4
  }
}

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

confluent_cloud_wh

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

hybrid_deployment_agent_id

string

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

example:

hybrid_deployment_agent_id

config

object

schema_registry_api_secret

string

Schema registry API secret.

format:

password

example:

your_schema_registry_API_secret

schema_registry

object

Schema Registry

enum:

"AIVEN_KARAPACE""CONFLUENT_CLOUD""AWS_GLUE"

data_format

object

Confluent Cloud message format.

enum:

"JSON""AVRO"

replication_factor

integer

Replication factor.

format:

int32

example:

schema_registry_api_key

string

Schema registry API key.

format:

password

example:

your_schema_registry_API_key

sasl_plain_secret

string

Confluent Cloud SASL secret.

format:

password

example:

your_API_secret

bootstrap_servers

array

Comma-separated list of Confluent Cloud servers in the server:port format.

example:

string

type:

string

connection_method

object

enum:

"privatelink""direct"

schema_registry_url

string

Schema registry URL.

example:

http

enable_single_topic

boolean

Populate all tables in a single topic.

example:

true

sasl_plain_key

string

Confluent Cloud SASL key.

format:

password

example:

your_API_key

sasl_mechanism

object

Security protocol for Confluent Cloud interaction.

enum:

"PLAIN""SCRAM_SHA_512""SCRAM_SHA_256""AWS_IAM"

security_protocol

object

Security protocol for Confluent Cloud interaction.

enum:

"SASL""SASL_PLAINTEXT"

num_of_partitions

integer

Number of partitions per topic.

format:

int32

example:

{
  "code": "Created",
  "message": "Operation performed.",
  "data": {
    "id": "destination_id",
    "service": "confluent_cloud_wh",
    "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",
    "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
    "config": {
      "schema_registry_api_secret": "your_schema_registry_API_secret",
      "schema_registry": "CONFLUENT_CLOUD | AWS_GLUE | AIVEN_KARAPACE",
      "data_format": "JSON | AVRO",
      "replication_factor": 3,
      "schema_registry_api_key": "your_schema_registry_API_key",
      "sasl_plain_secret": "your_API_secret",
      "bootstrap_servers": [
        "string"
      ],
      "connection_method": "direct | privatelink",
      "schema_registry_url": "http",
      "enable_single_topic": true,
      "sasl_plain_key": "your_API_key",
      "sasl_mechanism": "PLAIN | SCRAM_SHA_512 | SCRAM_SHA_256 | AWS_IAM",
      "security_protocol": "SASL | SASL_PLAINTEXT",
      "num_of_partitions": 4
    }
  }
}