connections
Creates, updates, deletes, gets or lists a connections resource.
Overview
| Name | connections |
| Type | Resource |
| Id | fivetran.groups.connections |
Fields
The following fields are returned by SELECT queries:
- list
| Name | Datatype | Description |
|---|---|---|
id | string | The unique identifier for the group within the Fivetran system. (example: connection_id) |
external_secrets_manager_id | string | |
group_id | string | The unique identifier for the group within the Fivetran system. (example: group_id) |
hybrid_deployment_agent_id | string | |
private_link_id | string | |
proxy_agent_id | string | |
config | object | The connection setup configuration. |
connect_card | object | |
connect_card_config | object | |
connected_by | string | The unique identifier of the user who has created the connection in your account. (example: user_id) |
created_at | string (date-time) | The timestamp of when the group was created in your account. (example: 2024-12-01T15:43:29.013729Z) |
daily_sync_time | string | The optional parameter that defines the sync start time when the sync frequency is already set or being set by the current request to 1440. It can be specified in one hour increments starting from 00:00 to 23:00. If not specified, we will use the baseline sync start time. This parameter has no effect on the 0 to 60 minutes offset used to determine the actual sync start time. (example: 14:00) |
data_delay_sensitivity | string | (LOW, NORMAL, HIGH, CUSTOM, SYNC_FREQUENCY) |
data_delay_threshold | integer (int32) | |
destination_configuration | object | |
destination_schema_names | string | (FIVETRAN_NAMING, SOURCE_NAMING) |
external_secrets_keys_config | object | |
failed_at | string (date-time) | The timestamp of the time the connection sync failed last time. (example: 2024-12-01T15:43:29.013729Z) |
networking_method | string | (Directly, SshTunnel, PrivateLink, ProxyAgent, UnmanagedProxyAgent, Unknown) |
pause_after_trial | boolean | Specifies whether the connection should be paused after the free trial period has ended. |
paused | boolean | Specifies whether the connection is paused. |
schedule | object | |
schedule_type | string | The connection schedule config type. Supported values: auto, manual. Lets you disable or enable an automatic data sync on a schedule. (example: auto) |
schema | string | The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination. (example: gsheets.table) |
service | string | The name for the connector type within the Fivetran system. (example: google_sheets) |
service_version | integer (int32) | The connector type version within the Fivetran system. |
setup_tests | array | Setup tests results |
source_sync_details | string | Read-only, connector-specific sync state. Depending on the connector type, this object may include source scope identifiers such as accounts, profiles, or projects; per-entity cursors or checkpoints; or last-synced timestamps. This field is optional, and its schema varies by connector type. To determine whether a connector exposes this information and inspect its returned fields, use [Retrieve Connection Details](https://fivetran.com/docs/rest-api/api-reference/connections/connection-details). (opaque JSON object) |
status | object | The current state of the connection. |
succeeded_at | string (date-time) | The timestamp of the time the connection sync succeeded last time. (example: 2024-12-01T15:43:29.013729Z) |
sync_frequency | integer (int32) | The connection sync frequency in minutes. null when the connection's schedule has no single cadence to report, such as a custom cron or multiple-time-of-day schedule. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | group_id | schema, cursor, limit | Returns a list of information about all connections within a group in your Fivetran account. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
group_id | string | The unique identifier for the group within the Fivetran system. |
cursor | string | Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination) |
limit | integer (int32) | Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100. |
schema | string | The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination. |
SELECT examples
- list
Returns a list of information about all connections within a group in your Fivetran account.
SELECT
id,
external_secrets_manager_id,
group_id,
hybrid_deployment_agent_id,
private_link_id,
proxy_agent_id,
config,
connect_card,
connect_card_config,
connected_by,
created_at,
daily_sync_time,
data_delay_sensitivity,
data_delay_threshold,
destination_configuration,
destination_schema_names,
external_secrets_keys_config,
failed_at,
networking_method,
pause_after_trial,
paused,
schedule,
schedule_type,
"schema",
service,
service_version,
setup_tests,
source_sync_details,
status,
succeeded_at,
sync_frequency
FROM fivetran.groups.connections
WHERE group_id = '{{ group_id }}' -- required
AND "schema" = '{{ schema }}'
AND "limit" = '{{ limit }}'
;