POST /v1/connections
Creates a new connection within a specified group in your Fivetran account. Runs setup tests and returns testing results.
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 |
|---|---|---|---|
daily_sync_time |
String | No |
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 |
pause_after_trial |
Boolean | No |
Specifies whether the connection should be paused after the free trial period has ended |
connect_card_config |
Object | No | |
connect_card_config.hide_setup_guide |
Boolean | No |
An optional parameter that lets you hide the embedded setup guide in the Connect Card. |
connect_card_config.redirect_uri |
String | Yes |
The URI on your site we redirect the end user to after successful setup. The URI must start with the |
sync_frequency |
Integer | No |
The connection sync frequency in minutes Possible values:
|
networking_method |
String | No |
Possible values:
|
hybrid_deployment_agent_id |
String | No |
The unique identifier for the hybrid deployment agent within the Fivetran system. If not specified, the agent ID from the destination will be used |
data_delay_threshold |
Integer | No |
Custom sync delay notification threshold in minutes. The default value is 0. This parameter is only used when data_delay_sensitivity set to CUSTOM. |
service |
String | Yes |
The connector name within the Fivetran system |
paused |
Boolean | No |
Specifies whether the connection is paused |
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 the setup tests should be run automatically. The default value is TRUE. |
schedule_type |
String | No |
The connection schedule configuration type. Supported values: auto, manual Possible values:
|
private_link_id |
String | No |
The unique identifier for the self-served private link that is used by the connection |
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. |
data_delay_sensitivity |
String | No |
The level of data delay notification threshold. Possible values: LOW, NORMAL, HIGH, CUSTOM, SYNC_FREQUENCY. The default value NORMAL. CUSTOM is only available for customers using the Enterprise plan or above. Possible values:
|
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.