Output only. Identifier. Name of the backup vault to create. It must have the format"projects/{project}/locations/{location}/backupVaults/{backupvault}". {backupvault} cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location.
Required. Field mask is used to specify the fields to be overwritten in the BackupVault resource by the update. The fields specified in the updateMask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail.
This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
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 since 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).
validateOnly
boolean
Optional. Only validate the request, but do not perform mutations. The default is 'false'.
force
boolean
Optional. If set to true, will not check plan duration against backup vault enforcement duration.
forceUpdateAccessRestriction
boolean
Optional. If set to true, we will force update access restriction even if some non compliant data sources are present. The default is 'false'.
Request body
The request body contains an instance of BackupVault.
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-07-08 UTC."],[[["\u003cp\u003eThis page details how to update the settings of a BackupVault using a PATCH HTTP request to a specific URL endpoint.\u003c/p\u003e\n"],["\u003cp\u003eThe URL endpoint requires a path parameter, \u003ccode\u003ebackupVault.name\u003c/code\u003e, which uniquely identifies the BackupVault to be updated.\u003c/p\u003e\n"],["\u003cp\u003eSeveral query parameters are available, including \u003ccode\u003eupdateMask\u003c/code\u003e (required), \u003ccode\u003erequestId\u003c/code\u003e, \u003ccode\u003evalidateOnly\u003c/code\u003e, and \u003ccode\u003eforce\u003c/code\u003e, which provide options to manage the update process.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must contain a BackupVault instance, and a successful update will return an Operation instance in the response body.\u003c/p\u003e\n"],["\u003cp\u003eUpdating a BackupVault requires the \u003ccode\u003ebackupdr.backupVaults.update\u003c/code\u003e IAM permission and the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.backupVaults.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\nUpdates the settings of a BackupVault.\n\n### HTTP request\n\n`PATCH https://backupdr.googleapis.com/v1/{backupVault.name=projects/*/locations/*/backupVaults/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body contains an instance of [BackupVault](/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupVaults#BackupVault).\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).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource:\n\n- `backupdr.backupVaults.update`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
