Move a Connection Beta

POST /v1/connections/4107c213907114059a5544ad8fa66c52/move HTTP/1.1
Accept: application/json;version=2
Authorization: Basic <Replace with base64-encoded key>
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 105

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

{
  "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",
    "job_id": "01234567-89ab-cdef-0123-456789abcdef"
  }
}

Limitations

General requirements

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

• The connection must be paused.
• For CONTINUE and BACKFILL, the connection must not have transformations. For transformation requirements that apply to CONTINUE_WITH_DATA, see the CONTINUE_WITH_DATA requirements section.
• The connection's source group must not use Hybrid Deployment.
• The source and target groups must belong to the same account and must be different groups.
• The connection's schema name must not already exist in the target destination group.

Database connector requirements

For the following connectors, you can only use BACKFILL when moving a connection across regions or cloud providers. You can use CONTINUE or CONTINUE_WITH_DATA for these connectors only when the source and target groups are in the same region and cloud provider:

• Generic PostgreSQL
• Amazon Aurora PostgreSQL
• Amazon RDS PostgreSQL
• Azure Database for PostgreSQL
• Google Cloud PostgreSQL
• Heroku PostgreSQL
• Generic MySQL
• Amazon Aurora MySQL
• Amazon RDS MySQL
• Azure Database for MySQL
• Google Cloud SQL for MySQL
• Generic MariaDB
• Amazon RDS MariaDB
• Magento
• Generic SQL Server
• Amazon RDS for SQL Server
• Azure SQL Database
• Azure SQL Managed Instance
• Google Cloud SQL for SQL Server
• Generic Oracle
• Amazon RDS for Oracle
• Oracle RAC
• Oracle E-Business Suite

CONTINUE_WITH_DATA requirements

When you use the CONTINUE_WITH_DATA sync behavior, the following additional requirements apply:

• You can use CONTINUE_WITH_DATA only to move a connection from its current Snowflake destination, which uses Native tables, to the linked target Snowflake destination, which uses Lakehouse tables.
• The current and target Snowflake destinations must use the same Host and database.
• The connection must not have any transformations for dbt. However, CONTINUE_WITH_DATA supports Quickstart transformations. As part of the move, Fivetran re-points the Quickstart transformations to the target destination's group. Each Quickstart project must reference only the connection you are moving.
• The connection must not have any incomplete schema migrations.
• The connection must not use the Source naming convention.
• Each connection can have only one move job with a PENDING or IN_PROGRESS status at a time.
• While the move job has a PENDING or IN_PROGRESS status, you cannot unpause, sync, or re-sync the connection. Wait until the job reaches SUCCESS or FAILED before continuing.
• You can move only one connection at a time.
• The connection's tables in the source destination must not have Snowflake masking policies that apply to the Fivetran role. If a masking policy applies to the Fivetran role, we copy the masked values to the target destination instead of the original values.

For more information, see our How to Migrate a Connection from Snowflake Native Tables to Lakehouse Tables Using Fivetran REST API tutorial.

Unstructured data requirements

For connectors that sync unstructured data, the target destination must support unstructured data.

Unsupported connectors

The Webhooks connector is not supported and cannot be moved.

Connections with credential dependencies

Fivetran evaluates the connection type and its stored credential values when you request a move. We treat a connection as having a credential dependency when any of the following conditions apply:

• Its AWS IAM authentication uses the current destination group ID as the trust policy External ID.
• Its stored credentials use a Fivetran-managed GCP service account email or key associated with the current destination group.
• Another stored credential field contains the current destination group ID.

If Fivetran REST API detects a credential dependency, it returns a 400 error with a message describing the required action. After you complete the required action, retry the request with "force_move": true.

Some connectors have credentials that depend on the current destination group — for example, connectors that use an AWS IAM trust policy or a GCP service account tied to the group. If you attempt to move such a connection, the API returns a 400 error with a message describing the required action. After you complete the required action, retry the request with "force_move": true.

Connectors that support unstructured file replication

The API returns a 400 error if all of the following conditions apply, whether or not you've enabled unstructured file replication for the connection:

• The connector supports unstructured file replication.
• The connection's current destination supports unstructured file replication.
• The target destination doesn't support unstructured file replication.

If the connection replicates unstructured files, Fivetran doesn't migrate them, and unstructured file replication is unavailable for the connection after the move. To proceed, retry the request with "force_move": true.

If the connection also requires force_move because of credential dependencies, the error message describes both, and a single retry with "force_move": true acknowledges both.