Backup for GKE API: Node.js Client

release level npm version

gkebackup client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:


Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Backup for GKE API API.
  4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/gke-backup


Samples are in the samples/ directory. Each sample's has instructions for running its sample.

SampleSource CodeTry it
Backup_for_g_k_e.create_backupsource codeOpen in Cloud Shell
Backup_for_g_k_e.create_backup_plansource codeOpen in Cloud Shell
Backup_for_g_k_e.create_restoresource codeOpen in Cloud Shell
Backup_for_g_k_e.create_restore_plansource codeOpen in Cloud Shell
Backup_for_g_k_e.delete_backupsource codeOpen in Cloud Shell
Backup_for_g_k_e.delete_backup_plansource codeOpen in Cloud Shell
Backup_for_g_k_e.delete_restoresource codeOpen in Cloud Shell
Backup_for_g_k_e.delete_restore_plansource codeOpen in Cloud Shell
Backup_for_g_k_e.get_backupsource codeOpen in Cloud Shell
Backup_for_g_k_e.get_backup_index_download_urlsource codeOpen in Cloud Shell
Backup_for_g_k_e.get_backup_plansource codeOpen in Cloud Shell
Backup_for_g_k_e.get_restoresource codeOpen in Cloud Shell
Backup_for_g_k_e.get_restore_plansource codeOpen in Cloud Shell
Backup_for_g_k_e.get_volume_backupsource codeOpen in Cloud Shell
Backup_for_g_k_e.get_volume_restoresource codeOpen in Cloud Shell
Backup_for_g_k_e.list_backup_planssource codeOpen in Cloud Shell
Backup_for_g_k_e.list_backupssource codeOpen in Cloud Shell
Backup_for_g_k_e.list_restore_planssource codeOpen in Cloud Shell
Backup_for_g_k_e.list_restoressource codeOpen in Cloud Shell
Backup_for_g_k_e.list_volume_backupssource codeOpen in Cloud Shell
Backup_for_g_k_e.list_volume_restoressource codeOpen in Cloud Shell
Backup_for_g_k_e.update_backupsource codeOpen in Cloud Shell
Backup_for_g_k_e.update_backup_plansource codeOpen in Cloud Shell
Backup_for_g_k_e.update_restoresource codeOpen in Cloud Shell
Backup_for_g_k_e.update_restore_plansource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

The Backup for GKE API Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/gke-backup@legacy-8 installs client libraries for versions compatible with Node.js 8.


This library follows Semantic Versioning.

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages


Contributions welcome! See the Contributing Guide.

Please note that this, the samples/, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.


Apache Version 2.0