Google Compute Engine: Node.js Client
Google Compute Engine Client Library for Node.js
A comprehensive list of changes in each version may be found inthe CHANGELOG.
- Google Compute Engine Node.js Client API Reference
- Google Compute Engine Documentation
- github.com/googleapis/nodejs-compute
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
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the Google Compute Engine API.
- Set up authentication with a service account so you can access theAPI from your local workstation.
Installing the client library
npm install @google-cloud/computeSamples
Samples are in thesamples/ directory. Each sample'sREADME.md has instructions for running its sample.
| Sample | Source Code | Try it |
|---|---|---|
| Create Instance | source code | ![]() |
| Create Instance From Template | source code | ![]() |
| Create Instance From Template With Overrides | source code | ![]() |
| Delete Instance | source code | ![]() |
| Disable Usage Export | source code | ![]() |
| Get Usage Export Bucket | source code | ![]() |
| List All Instances | source code | ![]() |
| List Images | source code | ![]() |
| List Images By Page | source code | ![]() |
| List Instances | source code | ![]() |
| Mailjet | source code | ![]() |
| Reset Instance | source code | ![]() |
| Sendgrid | source code | ![]() |
| Set Usage Export Bucket | source code | ![]() |
| Start Instance | source code | ![]() |
| Start Instance With Enc Key | source code | ![]() |
| Stop Instance | source code | ![]() |
| Wait For Operation | source code | ![]() |
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.
