Backup for GKE API

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

Service: gkebackup.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://gkebackup.googleapis.com

REST Resource: v1.projects.locations

Methods
getGET /v1/{name=projects/*/locations/*}
Gets information about a location.
listGET /v1/{name=projects/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1.projects.locations.backupPlans

Methods
createPOST /v1/{parent=projects/*/locations/*}/backupPlans
Creates a new BackupPlan in a given location.
deleteDELETE /v1/{name=projects/*/locations/*/backupPlans/*}
Deletes an existing BackupPlan.
getGET /v1/{name=projects/*/locations/*/backupPlans/*}
Retrieve the details of a single BackupPlan.
getIamPolicyGET /v1/{resource=projects/*/locations/*/backupPlans/*}:getIamPolicy
Gets the access control policy for a resource.
listGET /v1/{parent=projects/*/locations/*}/backupPlans
Lists BackupPlans in a given location.
/v1/{backupPlan.name=projects/*/locations/*/backupPlans/*}
Update a BackupPlan.
setIamPolicyPOST /v1/{resource=projects/*/locations/*/backupPlans/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissionsPOST /v1/{resource=projects/*/locations/*/backupPlans/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.backupPlans.backups

Methods
createPOST /v1/{parent=projects/*/locations/*/backupPlans/*}/backups
Creates a Backup for the given BackupPlan.
deleteDELETE /v1/{name=projects/*/locations/*/backupPlans/*/backups/*}
Deletes an existing Backup.
getGET /v1/{name=projects/*/locations/*/backupPlans/*/backups/*}
Retrieve the details of a single Backup.
getBackupIndexDownloadUrlGET /v1/{backup=projects/*/locations/*/backupPlans/*/backups/*}:getBackupIndexDownloadUrl
Retrieve the link to the backupIndex.
getIamPolicyGET /v1/{resource=projects/*/locations/*/backupPlans/*/backups/*}:getIamPolicy
Gets the access control policy for a resource.
listGET /v1/{parent=projects/*/locations/*/backupPlans/*}/backups
Lists the Backups for a given BackupPlan.
/v1/{backup.name=projects/*/locations/*/backupPlans/*/backups/*}
Update a Backup.
setIamPolicyPOST /v1/{resource=projects/*/locations/*/backupPlans/*/backups/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissionsPOST /v1/{resource=projects/*/locations/*/backupPlans/*/backups/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.backupPlans.backups.volumeBackups

Methods
getGET /v1/{name=projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*}
Retrieve the details of a single VolumeBackup.
getIamPolicyGET /v1/{resource=projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*}:getIamPolicy
Gets the access control policy for a resource.
listGET /v1/{parent=projects/*/locations/*/backupPlans/*/backups/*}/volumeBackups
Lists the VolumeBackups for a given Backup.
setIamPolicyPOST /v1/{resource=projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissionsPOST /v1/{resource=projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.operations

Methods
cancelPOST /v1/{name=projects/*/locations/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
deleteDELETE /v1/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
getGET /v1/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
listGET /v1/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request.

REST Resource: v1.projects.locations.restorePlans

Methods
createPOST /v1/{parent=projects/*/locations/*}/restorePlans
Creates a new RestorePlan in a given location.
deleteDELETE /v1/{name=projects/*/locations/*/restorePlans/*}
Deletes an existing RestorePlan.
getGET /v1/{name=projects/*/locations/*/restorePlans/*}
Retrieve the details of a single RestorePlan.
getIamPolicyGET /v1/{resource=projects/*/locations/*/restorePlans/*}:getIamPolicy
Gets the access control policy for a resource.
listGET /v1/{parent=projects/*/locations/*}/restorePlans
Lists RestorePlans in a given location.
/v1/{restorePlan.name=projects/*/locations/*/restorePlans/*}
Update a RestorePlan.
setIamPolicyPOST /v1/{resource=projects/*/locations/*/restorePlans/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissionsPOST /v1/{resource=projects/*/locations/*/restorePlans/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.restorePlans.restores

Methods
createPOST /v1/{parent=projects/*/locations/*/restorePlans/*}/restores
Creates a new Restore for the given RestorePlan.
deleteDELETE /v1/{name=projects/*/locations/*/restorePlans/*/restores/*}
Deletes an existing Restore.
getGET /v1/{name=projects/*/locations/*/restorePlans/*/restores/*}
Retrieves the details of a single Restore.
getIamPolicyGET /v1/{resource=projects/*/locations/*/restorePlans/*/restores/*}:getIamPolicy
Gets the access control policy for a resource.
listGET /v1/{parent=projects/*/locations/*/restorePlans/*}/restores
Lists the Restores for a given RestorePlan.
/v1/{restore.name=projects/*/locations/*/restorePlans/*/restores/*}
Update a Restore.
setIamPolicyPOST /v1/{resource=projects/*/locations/*/restorePlans/*/restores/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissionsPOST /v1/{resource=projects/*/locations/*/restorePlans/*/restores/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.restorePlans.restores.volumeRestores

Methods
getGET /v1/{name=projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*}
Retrieve the details of a single VolumeRestore.
getIamPolicyGET /v1/{resource=projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*}:getIamPolicy
Gets the access control policy for a resource.
listGET /v1/{parent=projects/*/locations/*/restorePlans/*/restores/*}/volumeRestores
Lists the VolumeRestores for a given Restore.
setIamPolicyPOST /v1/{resource=projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissionsPOST /v1/{resource=projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.