Google Cloud Deploy: Node.js Client

release level npm version

clouddeploy 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 Google Cloud Deploy 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/deploy

Using the client library

 * TODO(developer): Uncomment these variables before running the sample.
 *  Required. The parent, which owns this collection of pipelines. Format must be
 *  projects/{project_id}/locations/{location_name}.
// const parent = 'abc123'
 *  The maximum number of pipelines to return. The service may return
 *  fewer than this value. If unspecified, at most 50 pipelines will
 *  be returned. The maximum value is 1000; values above 1000 will be set
 *  to 1000.
// const pageSize = 1234
 *  A page token, received from a previous `ListDeliveryPipelines` call.
 *  Provide this to retrieve the subsequent page.
 *  When paginating, all other provided parameters match
 *  the call that provided the page token.
// const pageToken = 'abc123'
 *  Filter builds to be returned. See for more
 *  details.
// const filter = 'abc123'
 *  Field to sort by. See for more details.
// const orderBy = 'abc123'

// Imports the Deploy library
const {CloudDeployClient} = require('@google-cloud/deploy').v1;

// Instantiates a client
const deployClient = new CloudDeployClient();

async function listDeliveryPipelines() {
  // Construct request
  const request = {

  // Run request
  const iterable = await deployClient.listDeliveryPipelinesAsync(request);
  for await (const response of iterable) {



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

SampleSource CodeTry it
Cloud_deploy.abandon_releasesource codeOpen in Cloud Shell
Cloud_deploy.advance_rolloutsource codeOpen in Cloud Shell
Cloud_deploy.approve_rolloutsource codeOpen in Cloud Shell
Cloud_deploy.cancel_automation_runsource codeOpen in Cloud Shell
Cloud_deploy.cancel_rolloutsource codeOpen in Cloud Shell
Cloud_deploy.create_automationsource codeOpen in Cloud Shell
Cloud_deploy.create_custom_target_typesource codeOpen in Cloud Shell
Cloud_deploy.create_delivery_pipelinesource codeOpen in Cloud Shell
Cloud_deploy.create_releasesource codeOpen in Cloud Shell
Cloud_deploy.create_rolloutsource codeOpen in Cloud Shell
Cloud_deploy.create_targetsource codeOpen in Cloud Shell
Cloud_deploy.delete_automationsource codeOpen in Cloud Shell
Cloud_deploy.delete_custom_target_typesource codeOpen in Cloud Shell
Cloud_deploy.delete_delivery_pipelinesource codeOpen in Cloud Shell
Cloud_deploy.delete_targetsource codeOpen in Cloud Shell
Cloud_deploy.get_automationsource codeOpen in Cloud Shell
Cloud_deploy.get_automation_runsource codeOpen in Cloud Shell
Cloud_deploy.get_configsource codeOpen in Cloud Shell
Cloud_deploy.get_custom_target_typesource codeOpen in Cloud Shell
Cloud_deploy.get_delivery_pipelinesource codeOpen in Cloud Shell
Cloud_deploy.get_job_runsource codeOpen in Cloud Shell
Cloud_deploy.get_releasesource codeOpen in Cloud Shell
Cloud_deploy.get_rolloutsource codeOpen in Cloud Shell
Cloud_deploy.get_targetsource codeOpen in Cloud Shell
Cloud_deploy.ignore_jobsource codeOpen in Cloud Shell
Cloud_deploy.list_automation_runssource codeOpen in Cloud Shell
Cloud_deploy.list_automationssource codeOpen in Cloud Shell
Cloud_deploy.list_custom_target_typessource codeOpen in Cloud Shell
Cloud_deploy.list_delivery_pipelinessource codeOpen in Cloud Shell
Cloud_deploy.list_job_runssource codeOpen in Cloud Shell
Cloud_deploy.list_releasessource codeOpen in Cloud Shell
Cloud_deploy.list_rolloutssource codeOpen in Cloud Shell
Cloud_deploy.list_targetssource codeOpen in Cloud Shell
Cloud_deploy.retry_jobsource codeOpen in Cloud Shell
Cloud_deploy.rollback_targetsource codeOpen in Cloud Shell
Cloud_deploy.terminate_job_runsource codeOpen in Cloud Shell
Cloud_deploy.update_automationsource codeOpen in Cloud Shell
Cloud_deploy.update_custom_target_typesource codeOpen in Cloud Shell
Cloud_deploy.update_delivery_pipelinesource codeOpen in Cloud Shell
Cloud_deploy.update_targetsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

The Google Cloud Deploy 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/deploy@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