Run connector setup tests

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

Request schema

15five

Path parameters

connectorId

stringrequired

The unique identifier for the connector within the Fivetran system

example:

connector_id

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json;version=2

example:

application/json;version=2

Request

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

Http + 1.1

POST

https://api.fivetran.com/v1/connectors/connector_id/test

POST /v1/connectors/connector_id/test HTTP/1.1
Accept: application/json;version=2
Authorization: Basic REPLACE_BASIC_AUTH
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

Successful response schema

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

Operation performed.

data

objectrequired

stringrequired

The unique identifier for the connector within the Fivetran system

example:

connector_id

service

stringrequired

15five

The connector type name within the Fivetran system

example:

google_ads

schema

stringrequired

The name used both as the connector's name within the Fivetran system and as the source schema's name within your destination

example:

schema.table

paused

booleanrequired

Specifies whether the connector is paused

status

objectrequired

tasks

array

The collection of tasks for the connector

code

string

Code

example:

resync_table_warning

message

string

Warning message

example:

Resync Table Warning

details

string

warnings

array

The collection of warnings for the connector

code

string

Code

example:

resync_table_warning

message

string

Warning message

example:

Resync Table Warning

details

string

schema_status

string

Schema status. Returned only for connectors that support Universal Column Masking flow.

example:

ready

update_state

stringrequired

The current data update state of the connector. The available values are:
- on_schedule - the sync is running smoothly, no delays
- delayed - the data is delayed for a longer time than expected for the update.

example:

delayed

setup_state

stringrequired

The current setup state of the connector. The available values are:
- incomplete - the setup config is incomplete, the setup tests never succeeded
- connected - the connector is properly set up
- broken - the connector setup config is broken.

example:

connected

sync_state

stringrequired

The current sync state of the connector. The available values are:
- scheduled - the sync is waiting to be run
- syncing - the sync is currently running
- paused - the sync is currently paused
- rescheduled - the sync is waiting until more API calls are available in the source service.

example:

scheduled

is_historical_sync

booleanrequired

The boolean specifying whether the connector should be triggered to re-sync all historical data. If you set this parameter to TRUE, the next scheduled sync will be historical. If the value is FALSE or not specified, the connector will not re-sync historical data. NOTE: When the value is TRUE, only the next scheduled sync will be historical, all subsequent ones will be incremental. This parameter is set to FALSE once the historical sync is completed.

rescheduled_for

string

The scheduled time for the next sync when sync_state is rescheduled. If schedule_type is manual, then the connector expects triggering the event at the designated time through the Sync Connector Data endpoint.

format:

date-time

example:

2024-12-01T15:43:29.013729Z

daily_sync_time

string

The connector daily sync start time that we return only when the sync frequency is set to 1440 (which means 24 hours) and the daily_sync_time parameter was set using the Create a Connector or Update a Connector request

example:

14:00

succeeded_at

string

The timestamp of the time the connector sync succeeded last time

format:

date-time

example:

2024-03-17T12:31:40.870504Z

sync_frequency

integerrequired

The connector sync frequency in minutes

format:

int32

enum:

"1""5""15""30""60""120""180""360""480""720""1440"

group_id

stringrequired

The unique identifier for the group within the Fivetran system

example:

group_id

connected_by

stringrequired

The unique identifier of the user who has created the connector in your account

example:

user_id

setup_tests

array

Setup tests results for this connector

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 Passed

details

object

Setup test details.

example:

Test Details

source_sync_details

object

The additional information about the connector's state. The format of this parameter is specific for each connector type

service_version

integerrequired

The connector type version within the Fivetran system

format:

int32

created_at

stringrequired

The timestamp of the time the connector was created in your account

format:

date-time

example:

2023-12-01T15:43:29.013729Z

failed_at

string

The timestamp of the time the connector sync failed last time

format:

date-time

example:

2024-04-01T18:13:25.043659Z

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 proxy agent ID

example:

proxy_agent_id

networking_method

string

enum:

"Directly""SshTunnel""PrivateLink""ProxyAgent""UnmanagedPrivateLink""UnmanagedProxyAgent""Unknown"

connect_card

object

token

string

The connect-card auth token

example:

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkIjp7ImxvZ2luIjp0cnVlLCJ1c2VyIjoiX2FjY291bnR3b3J0aHkiLCJhY2NvdW50IjoiX21vb25iZWFtX2FjYyIsImdyb3VwIjoiX21vb25iZWFtIiwiY29ubmVjdG9yIjoiY29iYWx0X2VsZXZhdGlvbiIsIm1ldGhvZCI6IlBiZkNhcmQiLCJpZGVudGl0eSI6ZmFsc2V9LCJpYXQiOjE2Njc4MzA2MzZ9.YUMGUbzxW96xsKJLo4bTorqzx8Q19GTrUi3WFRFM8BU

uri

string

The Connect Card URI for the user interface

example:

https://fivetran.com/connect-card/setup?auth=eyJ0eXAiOiJKV1QiLCJh...

pause_after_trial

booleanrequired

Specifies whether the connector should be paused after the free trial period has ended

data_delay_threshold

integer

Custom sync delay notification threshold in minutes. The default value is 0. This parameter is only used when data_delay_sensitivity set to CUSTOM.

format:

int32

data_delay_sensitivity

stringrequired

The level of data delay notification threshold. Possible values: LOW, NORMAL, HIGH, CUSTOM. The default value NORMAL. CUSTOM is only available for customers using the Enterprise plan or above.

enum:

"LOW""NORMAL""HIGH""CUSTOM"

schedule_type

stringrequired

The connector schedule configuration type. Supported values: auto, manual

example:

auto

local_processing_agent_id

string

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

example:

local_processing_agent_id

connect_card_config

object

redirect_uri

stringrequired

The URI on your site we redirect the end user to after successful setup. The URI must start with the https or http prefix.

example:

https://your.site/path

hide_setup_guide

boolean

An optional parameter that lets you hide the embedded setup guide in the Connect Card.

example:

true

hide_branding

boolean

writeOnly:

true

hybrid_deployment_agent_id

string

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

example:

hybrid_deployment_agent_id

config

object

api_key

string

Your 15five API key.

format:

password

example:

your_15five_api_key

{
  "code": "Success",
  "message": "Operation performed.",
  "data": {
    "id": "connector_id",
    "service": "15five",
    "schema": "schema.table",
    "paused": false,
    "status": {
      "tasks": [
        {
          "code": "resync_table_warning",
          "message": "Resync Table Warning",
          "details": "string"
        }
      ],
      "warnings": [
        {
          "code": "resync_table_warning",
          "message": "Resync Table Warning",
          "details": "string"
        }
      ],
      "schema_status": "ready",
      "update_state": "delayed",
      "setup_state": "connected",
      "sync_state": "scheduled",
      "is_historical_sync": false,
      "rescheduled_for": "2024-12-01T15:43:29.013729Z"
    },
    "daily_sync_time": "14:00",
    "succeeded_at": "2024-03-17T12:31:40.870504Z",
    "sync_frequency": 1440,
    "group_id": "group_id",
    "connected_by": "user_id",
    "setup_tests": [
      {
        "title": "Test Title",
        "status": "PASSED",
        "message": "Test Passed",
        "details": "Test Details"
      }
    ],
    "source_sync_details": {},
    "service_version": 0,
    "created_at": "2023-12-01T15:43:29.013729Z",
    "failed_at": "2024-04-01T18:13:25.043659Z",
    "private_link_id": "private_link_id",
    "proxy_agent_id": "proxy_agent_id",
    "networking_method": "Directly",
    "connect_card": {
      "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkIjp7ImxvZ2luIjp0cnVlLCJ1c2VyIjoiX2FjY291bnR3b3J0aHkiLCJhY2NvdW50IjoiX21vb25iZWFtX2FjYyIsImdyb3VwIjoiX21vb25iZWFtIiwiY29ubmVjdG9yIjoiY29iYWx0X2VsZXZhdGlvbiIsIm1ldGhvZCI6IlBiZkNhcmQiLCJpZGVudGl0eSI6ZmFsc2V9LCJpYXQiOjE2Njc4MzA2MzZ9.YUMGUbzxW96xsKJLo4bTorqzx8Q19GTrUi3WFRFM8BU",
      "uri": "https://fivetran.com/connect-card/setup?auth=eyJ0eXAiOiJKV1QiLCJh..."
    },
    "pause_after_trial": false,
    "data_delay_threshold": 0,
    "data_delay_sensitivity": "NORMAL",
    "schedule_type": "auto",
    "local_processing_agent_id": "local_processing_agent_id",
    "connect_card_config": {
      "redirect_uri": "https://your.site/path",
      "hide_setup_guide": true,
      "hide_branding": true
    },
    "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
    "config": {
      "api_key": "your_15five_api_key"
    }
  }
}