Method: projects.instances.startExternalSync

Start External primary instance migration.

HTTP request

POST https://sqladmin.googleapis.com/v1/projects/{project}/instances/{instance}/startExternalSync

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`project`	`string` ID of the project that contains the instance.
`instance`	`string` Cloud SQL instance ID. This does not include the project ID.

project

string

ID of the project that contains the instance.

instance

string

Cloud SQL instance ID. This does not include the project ID.

Request body

The request body contains data with the following structure:

JSON representation

JSON representation
{"syncMode":enum (`ExternalSyncMode`),"skipVerification":boolean,"syncParallelLevel":enum (`ExternalSyncParallelLevel`),"migrationType":enum (`MigrationType`),// Union field`sync_config` can be only one of the following:"mysqlSyncConfig":{object (`MySqlSyncConfig`)}// End of list of possible types for union field`sync_config`.}

{"syncMode":enum (ExternalSyncMode),"skipVerification":boolean,"syncParallelLevel":enum (ExternalSyncParallelLevel),"migrationType":enum (MigrationType),// Union fieldsync_config can be only one of the following:"mysqlSyncConfig":{object (MySqlSyncConfig)}// End of list of possible types for union fieldsync_config.}

Fields
`syncMode`	`enum (ExternalSyncMode)` External sync mode.
`skipVerification`	`boolean` Whether to skip the verification step (VESS).
`syncParallelLevel`	`enum (ExternalSyncParallelLevel)` Optional. Parallel level for initial data sync. Currently only applicable for MySQL.
`migrationType`	`enum (MigrationType)` Optional. MigrationType configures the migration to use physical files or logical dump files. If not set, then the logical dump file configuration is used. Valid values are`LOGICAL` or`PHYSICAL`. Only applicable to MySQL.
Union field`sync_config`. `sync_config` can be only one of the following:
`mysqlSyncConfig`	`object (MySqlSyncConfig)` MySQL-specific settings for start external sync.

Response body

If successful, the response body contains an instance ofOperation.

Authorization scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/sqlservice.admin

For more information, see theAuthentication Overview.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-27 UTC.