Destination

Represents a destination in your Fivetran account. Destinations are the data warehouses, databases, or other storage systems where Fivetran loads your synced data. Each destination belongs to a group and can be connected to multiple connections.

Resource attributes

The following attributes describe a destination.

Field name	Type	Description
`id`	string, read-only	Unique identifier of the destination.
`group_id`	string	Unique identifier of the group the destination belongs to. Required when creating a destination.
`service`	string	The destination service type. For example, `snowflake` or `bigquery`.
`region`	string	Data processing location where Fivetran operates and runs computation on your data.
`time_zone_offset`	string	UTC offset used for sync scheduling. Accepts values from `-11` to `+12`.
`setup_status`	string, read-only	Current setup status of the destination. Possible values: `connected` - Destination is reachable and configured `incomplete` - Setup is not complete `broken` - Connection is broken or misconfigured.
`networking_method`	string	Connection option used to connect to the destination. Possible values: `Directly` - Direct connection `PrivateLink` - Private network link `SshTunnel` - Routes traffic through an SSH tunnel `ProxyAgent`- Routes traffic through a proxy agent.
`daylight_saving_time_enabled`	boolean	Indicates whether daylight saving time adjustments are applied to the sync schedule. Applies to U.S. time zones only.
`hybrid_deployment_agent_id`	string	Unique identifier of the hybrid deployment agent associated with the destination. Present only when a hybrid deployment agent is configured.
`private_link_id`	string	Unique identifier of the private link associated with the destination. Present only when a private link is configured.
`proxy_agent_id`	string	Unique identifier of the proxy agent associated with the destination. Present only when a proxy agent is configured.
`config`	object	Destination-specific configuration. Required fields vary by the service type. Returned in single-destination responses only.

Supported operations

Category	Endpoint	Description
List	`GET /v1/destinations`	Returns a paginated list of all destinations in the account.
Create	`POST /v1/destinations`	Creates a new destination.
Retrieve	`GET /v1/destinations/{destination_id}`	Returns the details of a destination.
Update	`PATCH /v1/destinations/{destination_id}`	Updates an existing destination.
Delete	`DELETE /v1/destinations/{destination_id}`	Deletes a destination.
Run setup tests	`POST /v1/destinations/{destination_id}/test`	Runs setup tests for a destination.