Google Compute Engine: Node.js Client

release level npm version

Node.js idiomatic client for Compute Engine. Compute Engine is a computing and hosting service that lets you create and run virtual machines on Google infrastructure. Compute Engine offers scale, performance, and value that lets you easily launch large compute clusters on Google's infrastructure. There are no upfront investments, and you can run thousands of virtual CPUs on a system that offers quick, consistent performance.

This library is GA from version 3.1.0. It is backwards-incompatible with prior versions 0.x.y, 1.x.y, 2.x.y, and 3.0.y.

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 Compute Engine 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/compute


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

SampleSource CodeTry it
Create Instancesource codeOpen in Cloud Shell
Create Instance From Templatesource codeOpen in Cloud Shell
Create Instance From Template With Overridessource codeOpen in Cloud Shell
Delete Instancesource codeOpen in Cloud Shell
Disable Usage Exportsource codeOpen in Cloud Shell
Get Usage Export Bucketsource codeOpen in Cloud Shell
List All Instancessource codeOpen in Cloud Shell
List Imagessource codeOpen in Cloud Shell
List Images By Pagesource codeOpen in Cloud Shell
List Instancessource codeOpen in Cloud Shell
Mailjetsource codeOpen in Cloud Shell
Reset Instancesource codeOpen in Cloud Shell
Sendgridsource codeOpen in Cloud Shell
Set Usage Export Bucketsource codeOpen in Cloud Shell
Start Instancesource codeOpen in Cloud Shell
Start Instance With Enc Keysource codeOpen in Cloud Shell
Stop Instancesource codeOpen in Cloud Shell
Wait For Operationsource codeOpen in Cloud Shell

The Google Compute Engine 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/compute@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