PATCH /v1/connections/{connectionId}
Updates the information for an existing connection within your Fivetran account.
Servers
- https://api.fivetran.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
connectionId |
String | Yes |
The unique identifier for the connection within the Fivetran system |
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 |
|---|---|---|---|
schema_status |
String | No |
Schema status. Possible values:
|
daily_sync_time |
String | No |
The connection daily sync start time that we return only when the sync frequency is set to 1440 (which means 24 hours) and the daily_sync_time parameter was set using the Create a Connection or Update a Connection request |
pause_after_trial |
Boolean | No |
Specifies whether the connection should be paused after the free trial period has ended |
networking_method |
String | No |
Possible values:
|
sync_frequency |
Integer | No |
The connection sync frequency in minutes Possible values:
|
is_historical_sync |
Boolean | No |
The boolean specifying whether the connection should be triggered to re-sync all historical data. If you set this parameter to TRUE, the next scheduled sync will be historical. If the value is FALSE or not specified, the connection will not re-sync historical data. NOTE: When the value is TRUE, only the next scheduled sync will be historical, all subsequent ones will be incremental. This parameter is set to FALSE once the historical sync is completed. |
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 |
config |
No |
The setup configuration. Check possible config formats in create method |
|
data_delay_threshold |
Integer | No | |
paused |
Boolean | No |
Specifies whether the connection is paused |
auth |
No |
The connector authorization settings. Check possible config formats in create method |
|
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 |
Possible values:
|
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.