Method: projects.locations.backupVaults.delete

Deletes a BackupVault.

HTTP request

DELETE https://backupdr.googleapis.com/v1/{name=projects/*/locations/*/backupVaults/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Name of the resource.

Query parameters

Parameters
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).
force

boolean

Optional. If set to true, any data source from this backup vault will also be deleted.
etag

string

The current etag of the backup vault. If an etag is provided and does not match the current etag of the connection, deletion will be blocked.
validateOnly

boolean

Optional. Only validate the request, but do not perform mutations. The default is 'false'.
allowMissing

boolean

Optional. If true and the BackupVault is not found, the request will succeed but no action will be taken.
ignoreBackupPlanReferences

boolean

Optional. If set to true, backupvault deletion will proceed even if there are backup plans referencing the backupvault. The default is 'false'.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • backupdr.backupVaults.delete

For more information, see the IAM documentation.