Method: projects.locations.restorePlans.delete

Deletes an existing RestorePlan.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Fully qualified RestorePlan name. Format: projects/*/locations/*/restorePlans/*

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

  • gkebackup.restorePlans.delete

Query parameters

Parameters
etag

string

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

force

boolean

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

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.