Re-sync Connection Data (Historical Sync)

Triggers a full historical sync of a connection or multiple schema tables within a connection. If the connection is paused, the table sync will be scheduled to be performed when the connection is re-enabled. If there is a data sync already in progress, we will try to complete it. If it fails, the request will be declined and the HTTP 409 Conflict error will be returned.

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

scope

object

A map where each key is a schema name and each value is a non-empty array of table names to re-sync within that schema. Both the scope object and each schema's table array must be non-empty — an empty scope object or an empty table array returns 400. If omitted or set to null, all schemas and tables of the connection are re-synced. This parameter is only supported for connectors that support table-level re-sync (typically database connectors such as PostgreSQL, MySQL, and Oracle). Sending scope to an unsupported connector type (for example, Google Sheets) returns 400. Retrieve valid schema and table names from GET /v1/connections/{connectionId}/schemas.

schema

array

Schema name

example:

[ "table1", "table2" ]

type:

string

Http + 1.1

POST

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

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

{
  "scope": {
    "schema": [
      "table1",
      "table2"
    ]
  }
}

Responses

200

Successful response

400

Bad request error. Returned when the scope object is empty, a schema key maps to an empty table array, or the connector does not support table-level re-sync.

401

Unauthorized error

404

Not found error

405

Method not allowed error

406

Not acceptable error

409

Conflict error. Returned when a data sync is already in progress and cannot be completed before the re-sync can be scheduled.

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'"
}