Method: projects.locations.restorePlans.restores.delete

Deletes an existing Restore.

HTTP request

DELETE https://gkebackup.googleapis.com/v1/{name=projects/*/locations/*/restorePlans/*/restores/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Full name of the Restore Format: projects/*/locations/*/restorePlans/*/restores/*

Authorization requires the following IAM permission on the specified resource name:

  • gkebackup.restores.delete

Query parameters

Parameters
etag

string

If provided, this value must match the current value of the target Restore's etag field or the request is rejected.

force

boolean

If set to true, any VolumeRestores below this restore will also be deleted. Otherwise, the request will only succeed if the restore has no VolumeRestores.

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.