Google

Backup for GKE API

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

Developer tools#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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

Endpoints 28

projects.locations.restorePlans.restores.volumeRestores

  • GETRetrieve the details of a single VolumeRestore./v1/:nameRetrieve the details of a single VolumeRestore.
  • GETGets the access control policy for a resource/v1/:resource:getIamPolicy?options.requestedPolicyVersion=0Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
  • POSTSets the access control policy on the specified resource/v1/:resource:setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
  • POSTReturns permissions that a caller has on the specified resource/v1/:resource:testIamPermissionsReturns 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…
  • GETLists the VolumeRestores for a given Restore./v1/:parent/volumeRestores?filter=string&orderBy=string&pageSize=0&pageToken=stringLists the VolumeRestores for a given Restore.

projects.locations.restorePlans.restores

  • DELETEDeletes an existing Restore./v1/:name?etag=string&force=trueDeletes an existing Restore.
  • PATCHUpdate a Restore./v1/:name?updateMask=stringUpdate a Restore.
  • GETLists the Restores for a given RestorePlan./v1/:parent/restores?filter=string&orderBy=string&pageSize=0&pageToken=stringLists the Restores for a given RestorePlan.
  • POSTCreates a new Restore for the given RestorePlan./v1/:parent/restores?restoreId=stringCreates a new Restore for the given RestorePlan.

projects.locations

  • GETLists information about the supported locations for this service/v1/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service. This method lists locations based on the resource scope provided in the…

projects.locations.backupChannels

  • GETLists BackupChannels in a given location./v1/:parent/backupChannels?filter=string&orderBy=string&pageSize=0&pageToken=stringLists BackupChannels in a given location.
  • POSTCreates a new BackupChannel in a given location./v1/:parent/backupChannels?backupChannelId=stringCreates a new BackupChannel in a given location.

projects.locations.backupChannels.backupPlanBindings

  • GETLists BackupPlanBindings in a given location./v1/:parent/backupPlanBindings?filter=string&orderBy=string&pageSize=0&pageToken=stringLists BackupPlanBindings in a given location.

projects.locations.backupPlans

  • GETLists BackupPlans in a given location./v1/:parent/backupPlans?filter=string&orderBy=string&pageSize=0&pageToken=stringLists BackupPlans in a given location.
  • POSTCreates a new BackupPlan in a given location./v1/:parent/backupPlans?backupPlanId=stringCreates a new BackupPlan in a given location.

projects.locations.restorePlans

  • GETReturns tags directly bound to a GCP resource./v1/:name:getTagsReturns tags directly bound to a GCP resource.
  • POSTUpdates tags directly bound to a GCP resource./v1/:name:setTagsUpdates tags directly bound to a GCP resource.
  • GETLists RestorePlans in a given location./v1/:parent/restorePlans?filter=string&orderBy=string&pageSize=0&pageToken=stringLists RestorePlans in a given location.
  • POSTCreates a new RestorePlan in a given location./v1/:parent/restorePlans?restorePlanId=stringCreates a new RestorePlan in a given location.

projects.locations.backupPlans.backups

  • GETLists the Backups for a given BackupPlan./v1/:parent/backups?filter=string&orderBy=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists the Backups for a given BackupPlan.
  • POSTCreates a Backup for the given BackupPlan./v1/:parent/backups?backupId=stringCreates a Backup for the given BackupPlan.
  • GETRetrieve the link to the backupIndex./v1/:backup:getBackupIndexDownloadUrlRetrieve the link to the backupIndex.

projects.locations.backupPlans.backups.volumeBackups

  • GETLists the VolumeBackups for a given Backup./v1/:parent/volumeBackups?filter=string&orderBy=string&pageSize=0&pageToken=stringLists the VolumeBackups for a given Backup.

projects.locations.operations

  • POSTStarts asynchronous cancellation on a long-running operation/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the…
  • GETLists operations that match the specified filter in the request/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

projects.locations.restoreChannels

  • GETLists RestoreChannels in a given location./v1/:parent/restoreChannels?filter=string&orderBy=string&pageSize=0&pageToken=stringLists RestoreChannels in a given location.
  • POSTCreates a new RestoreChannel in a given location./v1/:parent/restoreChannels?restoreChannelId=stringCreates a new RestoreChannel in a given location.

projects.locations.restoreChannels.restorePlanBindings

  • GETLists RestorePlanBindings in a given location./v1/:parent/restorePlanBindings?filter=string&orderBy=string&pageSize=0&pageToken=stringLists RestorePlanBindings in a given location.

API details

Base URL
https://gkebackup.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter
Operations
28 operations on 20 pathsGET 16POST 10PATCH 1DELETE 1
Main resources
projects.locations.restorePlans.restores.volumeRestores 5projects.locations.restorePlans 4projects.locations.restorePlans.restores 4projects.locations.backupPlans.backups 3projects.locations.backupChannels 2projects.locations.backupPlans 2projects.locations.operations 2projects.locations.restoreChannels 2projects.locations 1projects.locations.backupChannels.backupPlanBindings 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Backup for GKE API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Backup for GKE API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Retrieve the details of a single VolumeRestore.” (GET /v1/:name), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Backup for GKE API?

Backup for GKE is a managed Kubernetes workload backup and restore service for GKE clusters. It is listed under Developer tools and has 28 endpoints.

Who publishes the Backup for GKE API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Backup for GKE API?

Requests go to https://gkebackup.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Backup for GKE API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.

How many endpoints does the Backup for GKE API have?

28 operations on 20 paths (16 GET, 10 POST, 1 PATCH, 1 DELETE). The largest groups are projects.locations.restorePlans.restores.volumeRestores, projects.locations.restorePlans, projects.locations.restorePlans.restores, projects.locations.backupPlans.backups.

Is forking the Backup for GKE API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.