Connection

Represents a connection in a Fivetran destination group. A connection links a data source to a Fivetran destination, defining the full pipeline — including the source configuration, sync schedule, networking, and the destination to which data is synced.

Resource attributes

The following attributes define the identity, configuration, status, and other aspects of the connection resource that persist across the connection's lifetime.

Identity-related attributes

These fields identify the connection and the destination to which it syncs data.

Field name	Type	Description
`id`	`string`, read-only	Unique identifier for the connection.
`service`	`string`	Name for the connector type within the Fivetran system. For example, `salesforce` or `google_analytics`.
`schema`	`string`	Destination schema name. A schema name is permanent and cannot be changed after connection creation.
`group_id`	`string`	Identifier for the destination group this connection belongs to.
`connected_by`	`string`, read-only	Identifier of the user who created the connection.
`service_version`	`integer`, read-only	Connector version within the Fivetran system.

Configuration-related attributes

This field holds the connector-specific configuration for the connection.

Field name	Type	Description
`config`	`object`	Configuration parameters, such as credentials and source settings. The fields vary by service.

Status-related attributes

These fields report the setup state, sync state, and key timestamps for the connection.

The setup_state, sync_state, update_state, and is_historical_sync fields are sub-fields of the status object.

Field name	Type	Description
`setup_state`	`string`, read-only	Current setup state of the connection. Possible values: - `incomplete`: The connection setup config is incomplete; setup tests have never succeeded - `connected`: The connection is properly set up - `broken`: The connection setup config is broken
`sync_state`	`string`, read-only	Current sync state of the connection. Possible values: - `scheduled`: The sync is waiting to run - `syncing`: The sync is currently running - `paused`: The sync is currently paused - `rescheduled`: The sync is waiting for more API calls from the source
`update_state`	`string`, read-only	Current data update state of the connection. Possible values: - `on_schedule`: The sync is running smoothly with no delays - `delayed`: Data is delayed longer than expected
`is_historical_sync`	`boolean`, read-only	Indicates whether the next sync will be a historical sync (`true`) or an incremental sync (`false`).
`succeeded_at`	`string` (ISO-8601), read-only	Timestamp of the most recent successful sync.
`failed_at`	`string` (ISO-8601), read-only	Timestamp of the most recent failed sync.
`created_at`	`string` (ISO-8601), read-only	Timestamp when the connection was created.

Sync schedule-related attributes

These fields control when and how often the connection syncs.

Field name	Type	Description
`sync_frequency`	`integer`	Time interval between syncs, in minutes. Supported values: `1`, `5`, `15`, `30`, `60`, `120`, `180`, `360` (default), `480`, `720`, `1440`. For more information, see Set custom sync frequency.
`schedule_type`	`string`	Sync scheduling method. Supported values: `auto` (Fivetran-managed) or `manual`.
`daily_sync_time`	`string`	Time of day to run the sync when `sync_frequency` is `1440` (24 hours). Specify in one-hour increments from `00:00` to `23:00`.
`paused`	`boolean`	Specifies whether the connection is paused (`true`) or not (`false`).
`pause_after_trial`	`boolean`	Specifies whether the connection pauses automatically when a free trial ends (`true`) or continues syncing (`false`).

Data delay-related attributes

These fields configure sync delay notification settings for the connection.

Field name	Type	Description
`data_delay_sensitivity`	`string`	Determines when Fivetran sends a notification based on the level of data delay notification threshold. Possible values: `LOW`, `NORMAL` (default), `HIGH`, `SYNC_FREQUENCY`, or `CUSTOM`. `CUSTOM` is only available for customers using the Enterprise plan or above.
`data_delay_threshold`	`integer`	Custom threshold in minutes for sync delay alerts. Defaults to `0`. Only applies when `data_delay_sensitivity` is `CUSTOM`.

Networking-related attributes

These fields configure the network connectivity settings for the connection.

Field name	Type	Description
`networking_method`	`string`	Network connectivity method. Supported values: `Directly`, `SshTunnel`, `ProxyAgent`, or `PrivateLink`. Response-only values: `UnmanagedProxyAgent`, `Unknown`.
`private_link_id`	`string`	Identifier of the private link for this connection.
`proxy_agent_id`	`string`	Identifier of the proxy agent to route traffic through.
`hybrid_deployment_agent_id`	`string`	Identifier of the hybrid deployment agent for the Hybrid Deployment model. If not specified, the agent ID from the destination is used.

Supported operations

Once you have access to the Fivetran API, you can perform the following operations on the connection resource.

Category	Endpoint	Description
Connection provisioning	`POST /v1/connections`	Creates the connection resource.
Updates	`PATCH /v1/connections/{connectionId}`	Updates the connection configuration, schedule, or pause state.
Deletion	`DELETE /v1/connections/{connectionId}`	Permanently removes the connection.
Sync operations	`POST /v1/connections/{connectionId}/sync` `POST /v1/connections/{connectionId}/resync`	Triggers an incremental sync or a historical re-sync for the connection.
Setup tests	`POST /v1/connections/{connectionId}/test`	Runs setup tests to validate the connection configuration.
State	`GET /v1/connections/{connectionId}/state` `PATCH /v1/connections/{connectionId}/state`	Retrieves or updates the current sync state for the connection.
Connect Card	`POST /v1/connections/{connectionId}/connect-card`	Generates a Connect Card URL for embedding connector setup in your application.
Listing and discovery	`GET /v1/connections` `GET /v1/connections/{connectionId}`	Returns the list of connections and the full connection object.