POST /v1/connections/{connectionId}/sync
Triggers a data sync for an existing connection within your Fivetran account without waiting for the next scheduled sync. This action does not override the standard sync frequency you defined in the Fivetran dashboard.
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 |
|---|---|---|---|
force |
Boolean | No |
If force is true and the connection is currently syncing, it will stop the sync and re-run it. If force is false, the connection will sync only if it isn't currently syncing. The default value is false |
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.