Required. The resource name of the instance, in the format projects/{projectId}/locations/{locationId}/instances/{instanceId}.
Request body
The request body contains data with the following structure:
JSON representation
{"peerInstance": string}
Fields
peerInstance
string
Optional. The resource name of the peer instance to promote, in the format projects/{projectId}/locations/{locationId}/instances/{instanceId}. The peer instance is required if the operation is called on an active instance.
Response body
If successful, the response body contains an instance of Operation.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-17 UTC."],[[["\u003cp\u003eThis page details how to promote a standby instance (replica) using a POST HTTP request to a specific URL endpoint.\u003c/p\u003e\n"],["\u003cp\u003eThe request URL requires a path parameter named \u003ccode\u003ename\u003c/code\u003e, specifying the instance's resource path in the format \u003ccode\u003eprojects/{projectId}/locations/{locationId}/instances/{instanceId}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe body of the request to promote the replica must be empty, and it does not accept any inputs.\u003c/p\u003e\n"],["\u003cp\u003eUpon successful execution, the API will return an instance of \u003ccode\u003eOperation\u003c/code\u003e in the response body.\u003c/p\u003e\n"],["\u003cp\u003eTo successfully authorize this request, you must use the OAuth scope: \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.instances.promoteReplica\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nPromote the standby instance (replica).\n\n### HTTP request\n\n`POST https://file.googleapis.com/v1/{name=projects/*/locations/*/instances/*}:promoteReplica`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/filestore/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
