# Backup for GKE API API

> Backup for GKE API API on Apizie: 28 endpoints (Retrieve the details of a single VolumeRestore., Update a Restore., Deletes an existing Restore., Lists information about the supported locations for this service. This method lists locations based on the…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/analytics:googleapis-gkebackup/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `analytics:googleapis-gkebackup`
- Category: Analytics
- Status: byok
- Source: https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke
- Page: https://apizie.tech/api/analytics/googleapis-gkebackup
- OpenAPI: https://apizie.tech/api/analytics/googleapis-gkebackup/openapi.json

Backup for GKE is a managed Kubernetes workload backup and restore service for GKE clusters.

## Endpoints

### Retrieve the details of a single VolumeRestore.
`GET https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-restore-plans-restores-volume-r` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. Full name of the VolumeRestore resource. Format: `projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*` |

### Update a Restore.
`POST https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-restore-plans-restores-patch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Output only. Identifier. The full name of the Restore resource. Format: `projects/*/locations/*/restorePlans/*/restores/*` |
| updateMask | string | no | Optional. This is used to specify the fields to be overwritten in the Restore targeted for update. The values for each of these updated… |
| body | object | yes | JSON request body |

### Deletes an existing Restore.
`POST https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-restore-plans-restores-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| etag | string | no | Optional. If provided, this value must match the current value of the target Restore's etag field or the request is rejected. |
| force | boolean | no | Optional. If set to true, any VolumeRestores below this restore will also be deleted. Otherwise, the request will only succeed if the… |
| name | string | yes | Required. Full name of the Restore Format: `projects/*/locations/*/restorePlans/*/restores/*` |

### Lists information about the supported locations for this service. This method lists locations based on the…
`GET https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| extraLocationTypes | string | no | Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. |
| filter | string | no | A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is… |
| name | string | yes | The resource that owns the locations collection, if applicable. |
| pageSize | integer | no | The maximum number of results to return. If not set, the service selects a default. |
| pageToken | string | no | A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. |

### Lists BackupChannels in a given location.
`GET https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-backup-channels-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Field match expression used to filter the results. |
| orderBy | string | no | Optional. Field by which to sort the results. |
| pageSize | integer | no | Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service.… |
| pageToken | string | no | Optional. The value of next_page_token received from a previous `ListBackupChannels` call. Provide this to retrieve the subsequent page in… |
| parent | string | yes | Required. The location that contains the BackupChannels to list. Format: `projects/*/locations/*` |

### Creates a new BackupChannel in a given location.
`POST https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-backup-channels-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| backupChannelId | string | no | Optional. The client-provided short name for the BackupChannel resource. This name must: - be between 1 and 63 characters long (inclusive)… |
| parent | string | yes | Required. The location within which to create the BackupChannel. Format: `projects/*/locations/*` |
| body | object | yes | JSON request body |

### Lists BackupPlanBindings in a given location.
`GET https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-backup-channels-backup-plan-bin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Field match expression used to filter the results. |
| orderBy | string | no | Optional. Field by which to sort the results. |
| pageSize | integer | no | Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service.… |
| pageToken | string | no | Optional. The value of next_page_token received from a previous `ListBackupPlanBindings` call. Provide this to retrieve the subsequent… |
| parent | string | yes | Required. The BackupChannel that contains the BackupPlanBindings to list. Format: `projects/*/locations/*/backupChannels/*` |

### Lists BackupPlans in a given location.
`GET https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-backup-plans-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Field match expression used to filter the results. |
| orderBy | string | no | Optional. Field by which to sort the results. |
| pageSize | integer | no | Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service.… |
| pageToken | string | no | Optional. The value of next_page_token received from a previous `ListBackupPlans` call. Provide this to retrieve the subsequent page in a… |
| parent | string | yes | Required. The location that contains the BackupPlans to list. Format: `projects/*/locations/*` |

### Creates a new BackupPlan in a given location.
`POST https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-backup-plans-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| backupPlanId | string | no | Required. The client-provided short name for the BackupPlan resource. This name must: - be between 1 and 63 characters long (inclusive) -… |
| parent | string | yes | Required. The location within which to create the BackupPlan. Format: `projects/*/locations/*` |
| body | object | yes | JSON request body |

### Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not…
`GET https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-restore-plans-restores-volume-r-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| options.requestedPolicyVersion | integer | no | Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid… |
| resource | string | yes | REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names)… |

### Returns tags directly bound to a GCP resource.
`GET https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-restore-plans-get-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The full resource name of the service resource. |

### Sets the access control policy on the specified resource. Replaces any existing policy. Can return…
`POST https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-restore-plans-restores-volume-r-3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resource | string | yes | REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names)… |
| body | object | yes | JSON request body |

### Updates tags directly bound to a GCP resource.
`POST https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-restore-plans-set-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The full resource name of the service resource. |
| body | object | yes | JSON request body |

### Returns permissions that a caller has on the specified resource. If the resource does not exist, this will…
`POST https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-restore-plans-restores-volume-r-4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resource | string | yes | REQUIRED: The resource for which the policy detail is being requested. See [Resource… |
| body | object | yes | JSON request body |

### Lists the Backups for a given BackupPlan.
`GET https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-backup-plans-backups-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Field match expression used to filter the results. |
| orderBy | string | no | Optional. Field by which to sort the results. |
| pageSize | integer | no | Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service.… |
| pageToken | string | no | Optional. The value of next_page_token received from a previous `ListBackups` call. Provide this to retrieve the subsequent page in a… |
| parent | string | yes | Required. The BackupPlan that contains the Backups to list. Format: `projects/*/locations/*/backupPlans/*` |
| returnPartialSuccess | boolean | no | Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field will be… |

### Creates a Backup for the given BackupPlan.
`POST https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-backup-plans-backups-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| backupId | string | no | Optional. The client-provided short name for the Backup resource. This name must: - be between 1 and 63 characters long (inclusive) -… |
| parent | string | yes | Required. The BackupPlan within which to create the Backup. Format: `projects/*/locations/*/backupPlans/*` |
| body | object | yes | JSON request body |

### Retrieve the link to the backupIndex.
`GET https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-backup-plans-backups-get-backup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| backup | string | yes | Required. Full name of Backup resource. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup} |

### Lists the VolumeBackups for a given Backup.
`GET https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-backup-plans-backups-volume-bac` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Field match expression used to filter the results. |
| orderBy | string | no | Optional. Field by which to sort the results. |
| pageSize | integer | no | Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service.… |
| pageToken | string | no | Optional. The value of next_page_token received from a previous `ListVolumeBackups` call. Provide this to retrieve the subsequent page in… |
| parent | string | yes | Required. The Backup that contains the VolumeBackups to list. Format: `projects/*/locations/*/backupPlans/*/backups/*` |

### Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the…
`POST https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-operations-cancel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The name of the operation resource to be cancelled. |
| body | object | yes | JSON request body |

### Lists operations that match the specified filter in the request. If the server doesn't support this method,…
`GET https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-operations-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | The standard list filter. |
| name | string | yes | The name of the operation's parent resource. |
| pageSize | integer | no | The standard list page size. |
| pageToken | string | no | The standard list page token. |
| returnPartialSuccess | boolean | no | When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the… |

### Lists RestoreChannels in a given location.
`GET https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-restore-channels-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Field match expression used to filter the results. |
| orderBy | string | no | Optional. Field by which to sort the results. |
| pageSize | integer | no | Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service.… |
| pageToken | string | no | Optional. The value of next_page_token received from a previous `ListRestoreChannels` call. Provide this to retrieve the subsequent page… |
| parent | string | yes | Required. The location that contains the RestoreChannels to list. Format: `projects/*/locations/*` |

### Creates a new RestoreChannel in a given location.
`POST https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-restore-channels-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The location within which to create the RestoreChannel. Format: `projects/*/locations/*` |
| restoreChannelId | string | no | Optional. The client-provided short name for the RestoreChannel resource. This name must: - be between 1 and 63 characters long… |
| body | object | yes | JSON request body |

### Lists RestorePlanBindings in a given location.
`GET https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-restore-channels-restore-plan-b` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Field match expression used to filter the results. |
| orderBy | string | no | Optional. Field by which to sort the results. |
| pageSize | integer | no | Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service.… |
| pageToken | string | no | Optional. The value of next_page_token received from a previous `ListRestorePlanBindings` call. Provide this to retrieve the subsequent… |
| parent | string | yes | Required. The RestoreChannel that contains the ListRestorePlanBindings to list. Format: `projects/*/locations/*/restoreChannels/*` |

### Lists RestorePlans in a given location.
`GET https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-restore-plans-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Field match expression used to filter the results. |
| orderBy | string | no | Optional. Field by which to sort the results. |
| pageSize | integer | no | Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service.… |
| pageToken | string | no | Optional. The value of next_page_token received from a previous `ListRestorePlans` call. Provide this to retrieve the subsequent page in a… |
| parent | string | yes | Required. The location that contains the RestorePlans to list. Format: `projects/*/locations/*` |

### Creates a new RestorePlan in a given location.
`POST https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-restore-plans-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The location within which to create the RestorePlan. Format: `projects/*/locations/*` |
| restorePlanId | string | no | Required. The client-provided short name for the RestorePlan resource. This name must: - be between 1 and 63 characters long (inclusive) -… |
| body | object | yes | JSON request body |

### Lists the Restores for a given RestorePlan.
`GET https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-restore-plans-restores-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Field match expression used to filter the results. |
| orderBy | string | no | Optional. Field by which to sort the results. |
| pageSize | integer | no | Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service.… |
| pageToken | string | no | Optional. The value of next_page_token received from a previous `ListRestores` call. Provide this to retrieve the subsequent page in a… |
| parent | string | yes | Required. The RestorePlan that contains the Restores to list. Format: `projects/*/locations/*/restorePlans/*` |

### Creates a new Restore for the given RestorePlan.
`POST https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-restore-plans-restores-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The RestorePlan within which to create the Restore. Format: `projects/*/locations/*/restorePlans/*` |
| restoreId | string | no | Required. The client-provided short name for the Restore resource. This name must: - be between 1 and 63 characters long (inclusive) -… |
| body | object | yes | JSON request body |

### Lists the VolumeRestores for a given Restore.
`GET https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-restore-plans-restores-volume-r-5` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Field match expression used to filter the results. |
| orderBy | string | no | Optional. Field by which to sort the results. |
| pageSize | integer | no | Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service.… |
| pageToken | string | no | Optional. The value of next_page_token received from a previous `ListVolumeRestores` call. Provide this to retrieve the subsequent page in… |
| parent | string | yes | Required. The Restore that contains the VolumeRestores to list. Format: `projects/*/locations/*/restorePlans/*/restores/*` |

## Example
```
curl "https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-restore-plans-restores-volume-r" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Backup for GKE API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/analytics:googleapis-gkebackup/gkebackup-projects-locations-restore-plans-restores-volume-r with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Backup for GKE API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Backup for GKE API itself also needs your own key from googleapis.com.

### Can AI agents use the Backup for GKE API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key analytics:googleapis-gkebackup.

### What is the status of the Backup for GKE API API?
Needs your own provider key (bring your own key)