Required. Name of the backup plan association resource, in the format projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}
Request body
The request body contains data with the following structure:
JSON representation
{"ruleId": string,"requestId": string}
Fields
ruleId
string
Optional. backup ruleId for which a backup needs to be triggered. If not specified, on-demand backup with custom retention will be triggered.
requestId
string
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
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-08-07 UTC."],[[["\u003cp\u003eThis webpage documents the process of triggering a new backup via an HTTP POST request to the specified URL endpoint.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ename\u003c/code\u003e parameter in the URL path is a required string, representing the backup plan association resource identifier.\u003c/p\u003e\n"],["\u003cp\u003eThe request body requires a \u003ccode\u003eruleId\u003c/code\u003e string for identifying the backup rule, and an optional \u003ccode\u003erequestId\u003c/code\u003e to ensure request idempotency for 60 minutes.\u003c/p\u003e\n"],["\u003cp\u003eA successful request returns an Operation instance in the response body, indicating the result of the backup trigger.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization to trigger a backup requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.backupPlanAssociations.triggerBackup\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\nTriggers a new Backup.\n\n### HTTP request\n\n`POST https://backupdr.googleapis.com/v1/{name=projects/*/locations/*/backupPlanAssociations/*}:triggerBackup`\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](/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.operations#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)."]]
