APIHub
Back to Explore

Backup for GKE API

The Backup for GKE API provides programmatic management of backup and restore resources for Google Kubernetes Engine clusters, allowing you to create, list, update, and delete BackupPlans, Backups, RestorePlans, Restores, and their associated VolumeBackups and VolumeRestores, as well as manage long‑running operations and IAM policies.

Analytics
OAuth
HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

538ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
POST

/v1/{parent}/backups

Creates a Backup for the given BackupPlan.

  • parent (path, required) — Required. The BackupPlan within which to create the Backup. Format: `projects/*/locations/*/backupPlans/*`
  • backupId (query) — The client-provided short name for the Backup resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Backups in this BackupPlan
DELETE

/v1/{name}

Deletes an existing Restore.

  • name (path, required) — Required. Full name of the Restore Format: `projects/*/locations/*/restorePlans/*/restores/*`
  • etag (query) — If provided, this value must match the current value of the target Restore's etag field or the request is rejected.
  • force (query) — 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.
GET

/v1/{name}

Retrieve the details of a single VolumeRestore.

  • name (path, required) — Required. Full name of the VolumeRestore resource. Format: `projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*`
PATCH

/v1/{name}

Update a Restore.

  • name (path, required) — Output only. The full name of the Restore resource. Format: `projects/*/locations/*/restorePlans/*/restores/*`
  • updateMask (query) — This is used to specify the fields to be overwritten in the Restore targeted for update. The values for each of these updated fields will be taken from the `restore` provided with this request. Field names are relative to the root of the resource. If no `update_mask` is provided, all fields in `restore` will be written to the target Restore resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `restore` are ignored and are not used to update the target Restore.
GET

/v1/{name}/locations

Lists information about the supported locations for this service.

  • name (path, required) — The resource that owns the locations collection, if applicable.
  • filter (query) — A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
  • pageSize (query, limit) — The maximum number of results to return. If not set, the service selects a default.
  • pageToken (query) — A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
DELETE

/v1/{name}/operations

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

  • name (path, required) — The name of the operation resource to be deleted.
GET

/v1/{name}/operations

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

  • name (path, required) — The name of the operation's parent resource.
  • filter (query) — The standard list filter.
  • pageSize (query, limit) — The standard list page size.
  • pageToken (query) — The standard list page token.
POST

/v1/{name}:cancel

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

  • name (path, required) — The name of the operation resource to be cancelled.
GET

/v1/{parent}/backupPlans

Lists BackupPlans in a given location.

  • parent (path, required) — Required. The location that contains the BackupPlans to list. Format: `projects/*/locations/*`
  • filter (query) — Field match expression used to filter the results.
  • orderBy (query) — Field by which to sort the results.
  • pageSize (query, limit) — The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may inclue a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
  • pageToken (query) — The value of next_page_token received from a previous `ListBackupPlans` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupPlans` must match the call that provided the page token.
POST

/v1/{parent}/backupPlans

Creates a new BackupPlan in a given location.

  • parent (path, required) — Required. The location within which to create the BackupPlan. Format: `projects/*/locations/*`
  • backupPlanId (query) — Required. The client-provided short name for the BackupPlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupPlans in this location
GET

/v1/{parent}/backups

Lists the Backups for a given BackupPlan.

  • parent (path, required) — Required. The BackupPlan that contains the Backups to list. Format: `projects/*/locations/*/backupPlans/*`
  • filter (query) — Field match expression used to filter the results.
  • orderBy (query) — Field by which to sort the results.
  • pageSize (query, limit) — The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may inclue a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
  • pageToken (query) — The value of next_page_token received from a previous `ListBackups` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackups` must match the call that provided the page token.
GET

/v1/{parent}/restorePlans

Lists RestorePlans in a given location.

  • parent (path, required) — Required. The location that contains the RestorePlans to list. Format: `projects/*/locations/*`
  • filter (query) — Field match expression used to filter the results.
  • orderBy (query) — Field by which to sort the results.
  • pageSize (query, limit) — The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may inclue a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
  • pageToken (query) — The value of next_page_token received from a previous `ListRestorePlans` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListRestorePlans` must match the call that provided the page token.
POST

/v1/{parent}/restorePlans

Creates a new RestorePlan in a given location.

  • parent (path, required) — Required. The location within which to create the RestorePlan. Format: `projects/*/locations/*`
  • restorePlanId (query) — Required. The client-provided short name for the RestorePlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of RestorePlans in this location
GET

/v1/{parent}/restores

Lists the Restores for a given RestorePlan.

  • parent (path, required) — Required. The RestorePlan that contains the Restores to list. Format: `projects/*/locations/*/restorePlans/*`
  • filter (query) — Field match expression used to filter the results.
  • orderBy (query) — Field by which to sort the results.
  • pageSize (query, limit) — The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may inclue a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
  • pageToken (query) — The value of next_page_token received from a previous `ListRestores` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListRestores` must match the call that provided the page token.
POST

/v1/{parent}/restores

Creates a new Restore for the given RestorePlan.

  • parent (path, required) — Required. The RestorePlan within which to create the Restore. Format: `projects/*/locations/*/restorePlans/*`
  • restoreId (query) — Required. The client-provided short name for the Restore resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Restores in this RestorePlan.
GET

/v1/{parent}/volumeBackups

Lists the VolumeBackups for a given Backup.

  • parent (path, required) — Required. The Backup that contains the VolumeBackups to list. Format: `projects/*/locations/*/backupPlans/*/backups/*`
  • filter (query) — Field match expression used to filter the results.
  • orderBy (query) — Field by which to sort the results.
  • pageSize (query, limit) — The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may inclue a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
  • pageToken (query) — The value of next_page_token received from a previous `ListVolumeBackups` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListVolumeBackups` must match the call that provided the page token.
GET

/v1/{parent}/volumeRestores

Lists the VolumeRestores for a given Restore.

  • parent (path, required) — Required. The Restore that contains the VolumeRestores to list. Format: `projects/*/locations/*/restorePlans/*/restores/*`
  • filter (query) — Field match expression used to filter the results.
  • orderBy (query) — Field by which to sort the results.
  • pageSize (query, limit) — The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may inclue a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
  • pageToken (query) — The value of next_page_token received from a previous `ListVolumeRestores` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListVolumeRestores` must match the call that provided the page token.
GET

/v1/{resource}:getIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

  • resource (path, required) — REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
  • options.requestedPolicyVersion (query) — Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
POST

/v1/{resource}:setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

  • resource (path, required) — REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
POST

/v1/{resource}:testIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

  • resource (path, required) — REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

20 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X POST \
  "https://gkebackup.googleapis.com/v1/{parent}/backups"

gkebackup.googleapis.com · HTTPS only