Run Destination Setup Tests

Runs the setup tests for an existing destination within your Fivetran account.

aiven_kafka_wh

Request schema

Path parameters

destinationId

stringrequired

The unique identifier for the destination within the Fivetran system.

example:

destinationId

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json;version=2

example:

application/json;version=2

Request

trust_certificates

boolean

trust_fingerprints

boolean

Http + 1.1

POST

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

POST /v1/destinations/destinationId/test HTTP/1.1
Accept: application/json;version=2
Authorization: Basic 
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 62

{
  "trust_certificates": true,
  "trust_fingerprints": true
}

Responses

200

Successful response

404

Not found error

`200`

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

Setup tests have been completed

data

objectrequired

stringrequired

The unique identifier for the destination within the Fivetran system

example:

destination_id

service

stringrequired

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

"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"

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_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

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"

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

proxy_agent_id

string

The unique identifier for the proxy agent within the Fivetran system

example:

proxy_agent_id

setup_tests

array

Setup tests results for this destination

title

stringrequired

A human-readable name for the setup test step. For example: Validate Login, Test Connection, Check Permissions.

example:

Validate Login

status

stringrequired

The result of the individual setup test step. Possible values: PASSED, FAILED, SKIPPED.

enum:

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

message

string

The result message for the setup test step. For example: Invalid login credentials.

example:

Invalid login credentials.

details

object

Additional diagnostic information about the setup test result. Populated when the status is FAILED and more context is available beyond the message.

example:

Authentication failed (401 Unauthorized). Verify the provided credentials and permissions.

config

object

bootstrap_servers

array

example:

[ "string" ]

type:

string

connection_method

object

enum:

"privatelink""direct"

data_format

object

enum:

"JSON""AVRO"

enable_single_topic

boolean

example:

true

num_of_partitions

integer

format:

int32

replication_factor

integer

format:

int32

sasl_mechanism

object

enum:

"SCRAM_SHA_512""SCRAM_SHA_256"

sasl_plain_key

string

format:

password

example:

string

sasl_plain_secret

string

format:

password

example:

string

schema_registry

object

enum:

"AIVEN_KARAPACE""CONFLUENT_CLOUD"

schema_registry_api_key

string

format:

password

example:

string

schema_registry_api_secret

string

format:

password

example:

string

schema_registry_url

string

example:

string

security_protocol

object

enum:

"SASL""SASL_PLAINTEXT"

{
  "code": "Success",
  "message": "Setup tests have been completed",
  "data": {
    "id": "destination_id",
    "service": "aiven_kafka_wh",
    "region": "GCP_US_EAST4",
    "group_id": "group_id",
    "time_zone_offset": "+3",
    "setup_status": "CONNECTED",
    "daylight_saving_time_enabled": true,
    "private_link_id": "private_link_id",
    "networking_method": "Directly",
    "local_processing_agent_id": "local_processing_agent_id",
    "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
    "proxy_agent_id": "proxy_agent_id",
    "setup_tests": [
      {
        "title": "Validate Login",
        "status": "FAILED",
        "message": "Invalid login credentials.",
        "details": "Authentication failed (401 Unauthorized). Verify the provided credentials and permissions."
      }
    ],
    "config": {
      "bootstrap_servers": [
        "string"
      ],
      "connection_method": "privatelink | direct",
      "data_format": "JSON | AVRO",
      "enable_single_topic": true,
      "num_of_partitions": 0,
      "replication_factor": 0,
      "sasl_mechanism": "SCRAM_SHA_512 | SCRAM_SHA_256",
      "sasl_plain_key": "string",
      "sasl_plain_secret": "string",
      "schema_registry": "AIVEN_KARAPACE | CONFLUENT_CLOUD",
      "schema_registry_api_key": "string",
      "schema_registry_api_secret": "string",
      "schema_registry_url": "string",
      "security_protocol": "SASL | SASL_PLAINTEXT"
    }
  }
}