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 in the CHANGELOG.

• [Google Compute Engine Node.js Client API Reference][client-docs]
• [Google Compute Engine Documentation][product-docs]
• github.com/googleapis/google-cloud-node/packages/google-cloud-compute

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

Table of contents:

• Quickstart
  • Before you begin
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

Quickstart

Before you begin

1. [Select or create a Cloud Platform project][projects].
2. [Enable billing for your project][billing].
3. [Enable the Google Compute Engine API][enable_api].
4. [Set up authentication with a service account][auth] so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/compute

Using the client library

/**
 * TODO(developer): Uncomment and replace these variables before running the sample.
 */
// const projectId = 'YOUR_PROJECT_ID';

const compute = require('@google-cloud/compute');

// List all instances in the specified project.
async function listAllInstances() {
  const instancesClient = new compute.InstancesClient();

  //Use the `maxResults` parameter to limit the number of results that the API returns per response page.
  const aggListRequest = instancesClient.aggregatedListAsync({
    project: projectId,
    maxResults: 5,
  });

  console.log('Instances found:');

  // Despite using the `maxResults` parameter, you don't need to handle the pagination
  // yourself. The returned object handles pagination automatically,
  // requesting next pages as you iterate over the results.
  for await (const [zone, instancesObject] of aggListRequest) {
    const instances = instancesObject.instances;

    if (instances && instances.length > 0) {
      console.log(` ${zone}`);
      for (const instance of instances) {
        console.log(` - ${instance.name} (${instance.machineType})`);
      }
    }
  }
}

listAllInstances();

Samples

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

Changelog

npm history

5.2.0 (2025-05-09)

Features

• [compute] Update Compute Engine API to revision 20250320 (#6216) (130faf5)
• [compute] Update Compute Engine API to revision 20250415 (#6275) (b73d5bc)

5.1.0 (2025-03-19)

Features

• [compute] Update Compute Engine API to revision 20250302 (#987) (#6155) (dfab9f0)
• [compute] Update Compute Engine API to revision 20250302 (#995) (#6178) (2be675d)

Bug Fixes

• [Many APIs] await/catch promises, and update listOperationsAsync return type (#6184) (2fcd202)

5.0.0 (2025-03-18)

⚠ BREAKING CHANGES

• upgrade to Node 18 (#6096)

Features

• [Many APIs] add request/response debug logging to gapics (e7409c8)

Miscellaneous Chores

• Upgrade to Node 18 (#6096) (eadae64)

4.12.0 (2025-02-12)

Features

• [compute] Update Compute Engine API to revision 20250119 (#981) (#6003) (943c3b7)

4.11.0 (2025-01-23)

Features

• [compute] Update Compute Engine API to revision 20250107 (#975) (#5976) (752d41e)

4.10.0 (2025-01-16)

Features

• [compute] add Model Armor API (#5953) (50ecc13)

4.9.0 (2024-12-18)

Features

• [compute] Update Compute Engine API to revision 20241201 (#966) (#5873) (8bb5b1d)
• [compute] Update Compute Engine API to revision 20241201 (#971) (#5880) (21a7622)

4.8.0 (2024-11-14)

Features

• [compute] Update Compute Engine API to revision 20241105 (#954) (#5808) (058967a)

4.7.0 (2024-05-21)

Features

• [Many APIs] update Nodejs generator to send API versions in headers for GAPICs (#5351) (01f48fc)
• [Many APIs] update Nodejs generator to send API versions in headers for GAPICs (#5354) (a9784ed)

4.6.0 (2024-05-08)

Features

• Update Compute Engine API to revision 20240430 (#5321) (7f22a19)

4.5.0 (2024-05-02)

Features

• [compute] Update Compute Engine API to revision 20240421 (#899) (#5294) (f3e0606)

4.4.0 (2024-03-29)

Features

• [Many APIs] add several fields to manage state of database encryption update (#5187) (1952fbe)

4.3.0 (2024-03-07)

Features

• [compute] Update Compute Engine API to revision 20240220 (#886) (#5100) (7e4ae75)

4.2.0 (2024-02-09)

Features

• [compute] Trusted Private Cloud support, use the universeDomain parameter (#5016) (5a79fd0)
• [compute] Update Compute Engine API to revision 20240130 (#881) (#5031) (bf847d0)

4.1.0 (2023-12-11)

Features

• [compute] Update Compute Engine API to revision 20231110 (#868) (#4872) (4a79964)

Bug Fixes

• deps: Update dependency @sendgrid/mail to v8 (#4871) (493e0bd)

4.0.1 (2023-09-06)

Bug Fixes

• [Many APIs] simplify logic for HTTP/1.1 REST fallback option (#4584) (13537fc)

4.0.0 (2023-08-06)

⚠ BREAKING CHANGES

• migrate to Node 14 (#4443)

Bug Fixes

• [compute] fix typings for IAM methods (#4448) (55a2b0a)

Miscellaneous Chores

• Migrate to Node 14 (#4443) (2260f12)

3.10.0 (2023-07-11)

Features

• [compute] Update Compute Engine API to revision 20230610 (#820) (#4388) (67a4cef)
• [compute] Update Compute Engine API to revision 20230701 (#821) (#4406) (db3b83d)

3.9.1 (2023-04-13)

Bug Fixes

• deps: Bump google-gax to ^3.5.8 (#4117) (0b67d88)
• Minify JSON and JS files, and remove .map files (#4143) (170f7d5)

3.9.0 (2023-03-28)

Features

• [compute] Update Compute Engine API to revision 20230307 (#770) (#4091) (e6a35a6)
• [compute] Update Compute Engine API to revision 20230307 (#786) (#4113) (bea2478)

3.8.1 (2023-02-15)

Bug Fixes

• [Many APIs] changing format of the jsdoc links (#3986) (20f493c)

3.8.0 (2023-01-28)

Features

• Added Snooze API support (#3832) (f715797)
• Added SuggestConversationSummary RPC (#3851) (79fbaa8)
• Update Compute Engine API to revision 20230103 (#769) (#3873) (d3ec9cf)

3.7.0 (2022-12-16)

Features

• Update Compute Engine API to revision 20221101 (#751) (#3673) (6da677a)
• Update Compute Engine API to revision 20221126 (#757) (#3705) (07dd8f6)

3.6.0 (2022-11-17)

Features

• Update Compute Engine API to revision 20221011 (#736) (#856) (2c5e8e6)

Bug Fixes

• deps: Use google-gax v3.5.2 (#859) (6a1d0d6)
• update proto definitions (64bb3e5)
• Update proto definitions (#863) (64bb3e5)

3.5.1 (2022-09-22)

Bug Fixes

• Do not import the whole google-gax from proto JS (#1553) (#785) (b036441)
• use google-gax v3.3.0 (b036441)

3.5.0 (2022-09-08)

Features

• Update Compute Engine API to revision 20220720 (#723) (bd36f79)

Bug Fixes

• Add hashes to requirements.txt (#1544) (#782) (8c6b66a)
• Better support for fallback mode (#768) (bd36f79)
• Update google-gax and remove obsolete deps (#1545) (#775) (6f56b77)

3.4.0 (2022-07-04)

Features

• support regapic LRO (93343f6)

3.3.0 (2022-06-06)

Features

• Update Compute Engine API to revision 20220526 (#722) (#736) (11713af)

Bug Fixes

• deps: update dependency google-gax to v3 (#727) (b856cbd)
• fixes for dynamic routing and streaming descriptors (#733) (a10255d)

3.2.1 (2022-05-09)

Bug Fixes

• compute: remove proto3_optional from parent_id (#712) (#712) (f233960)
• compute: replace missing REQUIRED for parent_id (#711) (f233960)
• compute: revert proto3_optional, required removal on parent_id (#714) (#717) (072a9bd)

3.2.0 (2022-04-12)

Features

• update compute API to revision 20220322 (#710) (#709) (9bc4274)

3.1.2 (2022-02-16)

Bug Fixes

• docs: Add note in README mentioning tech discontinuity with previous version (#690) (4f0842e)

3.1.1 (2022-01-18)

Bug Fixes

• update release_level to reflect current status (#673) (c5da4c8)

3.1.0 (2022-01-11)

⚠ BREAKING CHANGES

• drop support for Node.js 10 (#668)
• 3.1.0
• IPProtocol enum has been renamed to IPProtocolEnum
• v3.1.0

Features

• add eslintignore for sameple generated code (#1302) (#652) (b170c29)
• add minimum wrapper for compute LRO method (#618) (2fa4f93)

Bug Fixes

• add parameter in compute bazel rules (#692) (#654) (115d1da)
• deps: update google-gax with http grpc status code mapping (#655) (ffa79f9)
• docs: increase memory for reference doc generation (#615) (5e63ce4)
• drop support for Node.js 10 (#668) (a4a5c9c)

Build System

• automate generation and updates with OwlBot (#651) (2b925fa)

Code Refactoring

• IPProtocol enum has been renamed to IPProtocolEnum (2b925fa)

3.0.0 (2021-08-17)

⚠ BREAKING CHANGES

• new generated version of compute API (#537)

Features

• new generated version of compute API (#537) (4023676)

Bug Fixes

• build: migrate to using main branch (#609) (3013bb5)
• deps: google-gax v2.24.1 (#612) (8569747)

2.6.0 (2021-06-29)

Features

• Adding implementation of startWithEncryptionKey api call (#539) (f8018a6)

2.5.1 (2021-06-10)

Bug Fixes

• flaky test (#563) (827a333)

2.5.0 (2021-05-25)

Features

• add gcf-owl-bot[bot] to ignoreAuthors (#557) (1e354f7)

2.4.4 (2021-05-04)

Bug Fixes

• disks: attach default disk first if needed (#551) (0523f0e), closes #518

2.4.3 (2021-01-27)

Bug Fixes

• handle parameters to image.create() (#541) (3b3a7dd)

2.4.2 (2021-01-07)

Bug Fixes

• createVM: do not define machineType or networkInterfaces when template provided (#530) (e7b705e), closes #529

2.4.1 (2020-11-25)

Bug Fixes

• skip tests for now (#523) (f0f8fae)

2.4.0 (2020-11-04)

Features

• add VM.get/setLabels() methods (#515) (60c87e6)

2.3.0 (2020-10-15)

Features

• add start param in getSerialPortOutput options (#507) (de3ecd4)

2.2.0 (2020-09-30)

Features

• support a source template when creating a VM (#500) (62f33be)

2.1.0 (2020-08-10)

Features

• add vm.update() method (#478) (7bcb79c)

2.0.3 (2020-07-27)

Bug Fixes

• move gitattributes files to node templates (#472) (4e1dd20)

2.0.2 (2020-07-09)

Bug Fixes

• do not override user-provided options (#463) (e51074c)
• typeo in nodejs .gitattribute (#461) (67ab7d7)

2.0.1 (2020-06-28)

Bug Fixes

• deps: update dependency gce-images to v3 (#443) (c861b8c)
• correct engines range to include node v10 (#451) (c8a2b29)
• update node issue template (#456) (65ab831)

2.0.0 (2020-05-08)

⚠ BREAKING CHANGES

• update to latest version of gts and typescript (#433)
• require node 10 in engines field (#431)

Features

• require node 10 in engines field (#431) (fe2897f)

Bug Fixes

• apache license URL (#468) (#427) (02d63ed)
• deps: update dependency @google-cloud/common to v3 (#421) (d4469b6)
• deps: update dependency @google-cloud/paginator to v3 (#419) (e667aee)
• deps: update dependency @google-cloud/projectify to v2 (#418) (b861540)
• deps: update dependency @google-cloud/promisify to v2 (#417) (eedce75)
• deps: update dependency @sendgrid/mail to v7 (#424) (17af0f4)

Build System

• update to latest version of gts and typescript (#433) (a4fa8cc)

1.2.0 (2020-01-23)

Features

• allow pollIntervalMs to be configured (#392) (0f9c6eb)

1.1.8 (2019-12-05)

Bug Fixes

• deps: pin TypeScript below 3.7.0 (5f1fc47)

1.1.7 (2019-12-02)

Bug Fixes

• docs: document correct object structure for zone.createVM (#371) (4551f1e)

1.1.6 (2019-11-15)

Bug Fixes

• docs: snippets are now replaced in jsdoc comments (#365) (408c75a)

1.1.5 (2019-09-10)

Bug Fixes

• update root url to compute.googleapis.com (#349) (4ad52a3)

1.1.4 (2019-08-28)

Bug Fixes

• docs: stop linking reference documents to anchor (48f90a0)

1.1.3 (2019-08-26)

Bug Fixes

• deps: use the latest extend (#344) (090bb96)

1.1.2 (2019-08-01)

Bug Fixes

• deps: update dependency @google-cloud/paginator to v2 (#338) (db5de8c)

1.1.1 (2019-06-26)

Bug Fixes

• docs: link to reference docs section on googleapis.dev (#333) (206a0fa)

1.1.0 (2019-06-20)

Bug Fixes

• docs: move to new client docs URL (#326) (918e352)

Features

• support apiEndpoint override (#322) (49c5384)

1.0.1 (2019-05-22)

Bug Fixes

• deps: update dependency async to v3 (#313) (c459c57)

1.0.0 (2019-05-20)

⚠ BREAKING CHANGES

• upgrade engines field to >=8.10.0 (#292)

Bug Fixes

• deps: update dependency @google-cloud/common to ^0.32.0 (#285) (a728cff)
• deps: update dependency @google-cloud/common to v1 (#303) (5b5e2e7)
• deps: update dependency @google-cloud/paginator to v1 (#297) (16b5ff2)
• deps: update dependency @google-cloud/projectify to v1 (#295) (30fff7d)
• deps: update dependency @google-cloud/promisify to v1 (#296) (166e99e)
• deps: update dependency arrify to v2 (#287) (4bc19c8)
• deps: update dependency gce-images to v2 (#304) (19eaaf5)
• deps: update dependency nodemailer to v6 (4c8e9c5)

Build System

• upgrade engines field to >=8.10.0 (#292) (4101d77)

Features

• Adds abandonInstances to InstanceGroupManger API (#306) (c359ce3)

v0.12.0

03-13-2019 14:47 PDT

New Features

• feat: Add getManagedInstances and deleteInstances to InstanceGroupManger API (#265)
• feat: add basic support for InstanceGroupManager (#263)

Bug Fixes

• fix: snapshot.delete() no longer throws (#251)

Dependencies

• fix(deps): update dependency @google-cloud/paginator to ^0.2.0 (#274)
• fix(deps): update dependency @google-cloud/promisify to ^0.4.0 (#267)
• fix(deps): update dependency @google-cloud/common to ^0.31.0 (#258)

Documentation

• docs: update links in contrib guide (#268)
• docs: update contributing path in README (#261)
• docs: move CONTRIBUTING.md to root (#260)
• docs: add lint/fix example to contributing guide (#257)
• docs: use the latest sendgrid npm module (#246)
• docs(samples): modernize the samples (#240)

Internal / Testing Changes

• build: Add docuploader credentials to node publish jobs (#272)
• build: use node10 to run samples-test, system-test etc (#271)
• build: update release configuration
• chore(deps): update dependency mocha to v6 (#269)
• build: use linkinator for docs test (#266)
• build: create docs test npm scripts (#264)
• build: test using @grpc/grpc-js in CI (#262)
• chore(deps): update dependency eslint-config-prettier to v4 (#255)
• build: ignore googleapis.com in doc link check (#252)
• build: check broken links in generated docs (#248)
• fix(deps): update dependency nodemailer to v5 (#247)
• refactor: use Object.assign where possible (#245)

v0.11.0

12-20-2018 16:17 PST

Bug fixes

• fix: asyncify and fix the system tests (#203)
• fix: Use PATCH semantics by default to set custom metadata (#171)
• fix: use teeny-request to reduce module size (#175)
• fix: drop support for node.js 4.x and 9.x (#126)
• fix: require use of new (#99)
• fix: update all the dependencies (#95)
• fix: Use correct URI for Snapshot instances (#67)
• fix: link (#62)

Dependencies

• fix(deps): upgrade to v0.29.1 of @google-cloud/nodejs-common (#241)
• fix(deps): update dependency @google-cloud/common to ^0.28.0 (#238)
• fix(deps): update dependency @google-cloud/common to ^0.27.0 (#215)
• fix(deps): upgrade to the latest gce-images (#201)
• fix(deps): update dependency @google-cloud/common to ^0.26.0 (#185)
• fix(deps): update dependency @google-cloud/common to ^0.25.0 (#121)
• chore(deps): use @google-cloud/projectify (#174)
• chore(deps): use @google-cloud/paginator (#173)
• chore(deps): use @google-cloud/promisify (#172)
• fix(package): update @google-cloud/common to version 0.20.0 (#101)
• Update @google-cloud/common to the latest version 🚀 (#57)

Documentation & Samples

• sample: improve the samples and tests (#236)
• docs: update readme badges (#219)
• docs(samples): update samples to use async/await and mocha (#183)
• sample: Show proper response structure in vm.getMetadata example (#169)
• sample: Add mailjet and sendgrid back in (#110)
• sample: Add sample demonstrating startup script (#80)
• docs: Fix Readme.md in /samples (#73)
• sample: Fix quickstart code sample (#69)
• docs: Fix jsdocs (#59)

Internal / Testing Changes

• chore: remove repo-tools from a few spots (#239)
• chore(build): inject yoshi automation key (#235)
• chore: update nyc and eslint configs (#234)
• chore: fix publish.sh permission +x (#232)
• fix(build): fix Kokoro release script (#231)
• build: add Kokoro configs for autorelease (#230)
• chore: add synth.metadata (#227)
• fix(deps): update dependency googleapis to v36 (#225)
• chore: always nyc report before calling codecov (#224)
• chore: nyc ignore build/test by default (#223)
• chore: update license file (#221)
• fix(build): fix system key decryption (#217)
• chore: update eslintignore config (#208)
• fix(deps): update dependency googleapis to v35 (#205)
• chore(deps): update dependency @google-cloud/nodejs-repo-tools to v3 (#204)
• chore: drop contributors from multiple places (#202)
• chore: use latest npm on Windows (#199)
• chore: update CircleCI config (#198)
• chore: include build in eslintignore (#195)
• chore(deps): update dependency eslint-plugin-node to v8 (#190)
• chore: update issue templates (#189)
• chore: remove old issue template (#187)
• build: run tests on node11 (#186)
• chores(build): do not collect sponge.xml from windows builds (#184)
• chores(build): run codecov on continuous builds (#182)
• chore: update new issue template (#181)
• build: fix codecov uploading on Kokoro (#177)
• Update kokoro config (#166)
• chore(deps): update dependency eslint-plugin-prettier to v3 (#165)
• fix(deps): update dependency googleapis to v34 (#162)
• build: prevent system/sample-test from leaking credentials
• Update CI config (#160)
• test: remove appveyor config (#159)
• Update the kokoro config (#158)
• Make it pass lint (#156)
• Enable prefer-const in the eslint config (#155)
• Fix the linter (#154)
• Enable no-var in eslint (#153)
• Update CI config (#152)
• Add synth script and update CI (#149)
• Retry npm install in CI (#148)
• chore(deps): update dependency nyc to v13 (#145)
• fix(deps): update dependency googleapis to v33 (#144)
• chore(deps): update dependency eslint-config-prettier to v3 (#143)
• chore: ignore package-lock.json (#142)
• chore(deps): lock file maintenance (#141)
• chore: update renovate config (#140)
• test: throw on deprecation (#139)
• chore(deps): lock file maintenance (#138)
• chore: assert.deelEqual => assert.deepStrictEqual (#137)
• chore: move mocha options to mocha.opts (#135)
• chore: require node 8 for samples (#136)
• chore(deps): lock file maintenance (#134)
• chore(deps): update dependency eslint-plugin-node to v7 (#132)
• test: use strictEqual in tests (#133)
• chore(deps): lock file maintenance (#131)
• chore(deps): update dependency @google-cloud/nodejs-repo-tools to v2.3.1 (#130)
• chore(deps): lock file maintenance (#129)
• chore(deps): lock file maintenance (#128)
• chore(deps): lock file maintenance (#127)
• chore(deps): lock file maintenance (#124)
• chore(deps): lock file maintenance (#123)
• chore(deps): update dependency @google-cloud/nodejs-repo-tools to v2.3.0 (#119)
• chore(deps): update dependency ava to v0.25.0 (#120)
• Configure Renovate (#112)
• refactor: drop repo-tool as an exec wrapper (#118)
• chore: update sample lockfiles (#117)
• fix: update linking for samples (#115)
• chore(package): update eslint to version 5.0.0 (#113)
• chore(package): update nyc to version 12.0.2 (#94)
• Fix formatting (#92)
• Simplify JS and use HTML standard (#91)
• chore: lock files maintenance (#88)
• chore: run circle as non-root, fix npm link (#89)
• chore: the ultimate fix for repo-tools EPERM (#87)
• Fix problem with multiple deletes in test (#85)
• Increase timeout in startup sample test (#86)
• chore: timeout for system test (#84)
• chore: lock files maintenance (#78)
• test: make samples tests pass (#77)
• Do not show sample for Google API Client library (#76)
• chore: test on node10 (#74)
• Update repo-tools to 2.3.0 (#72)
• chore: lock files maintenance (#71)
• chore: one more workaround for repo-tools EPERM (#60)
• chore: workaround for repo-tools EPERM (#58)
• chore: setup nighty build in CircleCI (#56)
• Upgrade repo-tools and regenerate scaffolding. (#55)