Move a Connection (Beta) Beta

Moves a connection from its current destination group to a different destination group. The connection must be paused before calling this endpoint. Use sync_behavior to control how data syncs after the move: CONTINUE preserves the existing sync cursor so the connection resumes incremental sync from where it left off; BACKFILL resets the cursor and triggers a historical sync.

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

destination_group_id

stringrequired

The unique identifier of the destination group to move the connection to. Retrieve group IDs from the List All Groups endpoint.

example:

destination_group_id

sync_behavior

string

Controls how data syncs after the move. Use CONTINUE to preserve the existing sync cursor so the connection resumes incremental sync from where it left off. Use BACKFILL to reset the cursor and trigger a historical sync.

enum:

"CONTINUE""BACKFILL"

Http + 1.1

POST

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

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

{
  "destination_group_id": "destination_group_id",
  "sync_behavior": "CONTINUE"
}

Responses

200

Successful response

400

Bad request error

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

string

Response status text

example:

Connection moved successfully

data

objectrequired

connection_id

stringrequired

The unique identifier of the connection that was moved.

example:

connection_id

source_group_id

stringrequired

The unique identifier of the destination group the connection was moved from.

example:

source_group_id

destination_group_id

stringrequired

The unique identifier of the destination group to move the connection to. Retrieve group IDs from the List All Groups endpoint.

example:

destination_group_id

sync_behavior

stringrequired

enum:

"CONTINUE""BACKFILL"

moved_at

stringrequired

The timestamp of when the connection was moved.

format:

date-time

example:

2024-01-01T00:00:00Z

{
  "code": "Success",
  "message": "Connection moved successfully",
  "data": {
    "connection_id": "connection_id",
    "source_group_id": "source_group_id",
    "destination_group_id": "destination_group_id",
    "sync_behavior": "CONTINUE",
    "moved_at": "2024-01-01T00:00:00Z"
  }
}

Limitations

Requirements

The following conditions must be met before you can move a connection:

The connection must be paused.
The connection must not have transformations.
The connection must not use a hybrid deployment destination.
The connection's schema name must not already exist in the target destination group.

Unsupported connectors

Some connectors are not currently supported for move because their credentials contain a dependency on the current destination group. This occurs when a connector stores the destination group ID in fields such as IAM external IDs or service principal paths during the initial setup — for example, as part of an AWS IAM trust policy or a Google service principal configuration.

If you attempt to move such a connection, the API returns a 400 error with the following message:

This connector cannot be moved because it has a dependency on the current destination group