Method: instances.promoteReplica
- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Examples
- Try it!
Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.
HTTP request
POST https://sqladmin.googleapis.com/v1/projects/{project}/instances/{instance}/promoteReplica
The URL usesgRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
project |
ID of the project that contains the read replica. |
instance |
Cloud SQL read replica instance name. |
Query parameters
| Parameters | |
|---|---|
failover |
Set to true to invoke a replica failover to the DR replica. As part of replica failover, the promote operation attempts to add the original primary instance as a replica of the promoted DR replica when the original primary instance comes back online. If set to false or not specified, then the original primary instance becomes an independent Cloud SQL primary instance. |
Request body
The request body must be empty.
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-platformhttps://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-24 UTC.