POST /v1/destinations
Creates a new destination within a specified group in your Fivetran account.
IMPORTANT: Groups and destinations are mapped 1:1 to each other. We do this mapping using the group's
id
value that we automatically generate when you create a group, and the destination'sgroup_id
value that you specify when you create a destination. This means that you must create a group in your Fivetran account before you can create a destination in it.
Servers
- https://api.fivetran.com
Request headers
Name | Type | Required | Description |
---|---|---|---|
Accept |
String | No |
Default value: "application/json;version=2" |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
region |
String | No |
Data processing location. This is where Fivetran will operate and run computation on data. Possible values:
|
daylight_saving_time_enabled |
Boolean | No |
Shift my UTC offset with daylight savings time (US Only) |
trust_fingerprints |
Boolean | No |
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. |
proxy_agent_id |
String | No |
The unique identifier for the proxy agent within the Fivetran system |
run_setup_tests |
Boolean | No |
Specifies whether setup tests should be run automatically. |
time_zone_offset |
String | Yes |
Determines the time zone for the Fivetran sync schedule. Possible values:
|
hybrid_deployment_agent_id |
String | No |
The unique identifier for the hybrid deployment agent within the Fivetran system |
private_link_id |
String | No |
The unique identifier for the self-served private link that is used by the connection |
networking_method |
String | No |
Possible values:
|
service |
String | Yes |
The name for the destination type within the Fivetran system. |
trust_certificates |
Boolean | No |
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. |
group_id |
String | Yes |
The unique identifier for the group within the Fivetran system. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.