Google Compute Engine: Node.js Client

release levelnpm versioncodecov

Google Compute Engine Client Library for Node.js

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

Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient Libraries Explained.

Table of contents:

Quickstart

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 theAPI from your local workstation.

Installing the client library

npm install @google-cloud/compute

Samples

Samples are in thesamples/ directory. Each sample'sREADME.md 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

TheGoogle Compute Engine Node.js Client API Reference documentationalso contains samples.

Supported Node.js Versions

Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.

Client libraries targeting some end-of-life versions of Node.js are available, andcan be installed via npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).

Legacy Node.js versions are supported as a best effort:

  • Legacy versions will not be tested in continuous integration.
  • Some security patches may not be able to be backported.
  • Dependencies will not be kept up-to-date, and features will not be backported.

Legacy tags available

  • legacy-8: install client libraries from this dist-tag for versionscompatible with Node.js 8.

Versioning

This library followsSemantic Versioning.

This library is considered to be inalpha. This means it is still awork-in-progress and under active development. Any release is subject tobackwards-incompatible changes at any time.

More Information:Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See theContributing Guide.

Please note that thisREADME.md, thesamples/README.md,and a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template. To edit one of these files, make an editto its templates indirectory.

License

Apache Version 2.0

SeeLICENSE

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-03 UTC.