Sync Connection Data

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.

When schedule_type is set to manual, this endpoint is the only way syncs occur — including syncs in a rescheduled state. For a full walkthrough, see Trigger Manual Syncs.

Request schema

Path parameters

connectionId

stringrequired

The unique identifier of the connection. Retrieve it from the id field in the List All Connections response, or from the id field returned when you Create a Connection.

example:

4107c213907114059a5544ad8fa66c52

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json;version=2

example:

application/json;version=2

Request

force

boolean

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

example:

true

Http + 1.1

POST

https://api.fivetran.com/v1/connections/4107c213907114059a5544ad8fa66c52/sync

POST /v1/connections/4107c213907114059a5544ad8fa66c52/sync HTTP/1.1
Accept: application/json;version=2
Authorization: Basic 
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 19

{
  "force": true
}

Responses

200

Successful response

401

Unauthorized error

404

Not found error

406

Not acceptable error

415

Unsupported media type error

`200`

code

stringrequired

Response status code

example:

Success

message

stringrequired

Response status text

example:

Sync has been successfully triggered for connection with id 'string'

{
  "code": "Success",
  "message": "Sync has been successfully triggered for connection with id 'string'"
}