Nightly Panic Munchies

    TypeScript icon, indicating that this package has built-in type declarations

    5.0.0 • Public • Published

    Google Cloud Platform logo

    GCP Metadata: Node.js Client

    release level npm version

    Get the metadata from a Google Cloud Platform environment

    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:


    Installing the client library

    npm install gcp-metadata

    Using the client library

    const gcpMetadata = require('gcp-metadata');
    async function quickstart() {
      // check to see if this code can access a metadata server
      const isAvailable = await gcpMetadata.isAvailable();
      console.log(`Is available: ${isAvailable}`);
      // Instance and Project level metadata will only be available if
      // running inside of a Google Cloud compute environment such as
      // Cloud Functions, App Engine, Kubernetes Engine, or Compute Engine.
      // To learn more about the differences between instance and project
      // level metadata, see:
      if (isAvailable) {
        // grab all top level metadata from the service
        const instanceMetadata = await gcpMetadata.instance();
        console.log('Instance metadata:');
        // get all project level metadata
        const projectMetadata = await gcpMetadata.project();
        console.log('Project metadata:');

    Check to see if the metadata server is available

    const isAvailable = await gcpMetadata.isAvailable();

    Access all metadata

    const data = await gcpMetadata.instance();
    console.log(data); // ... All metadata properties

    Access specific properties

    const data = await gcpMetadata.instance('hostname');
    console.log(data); // ...Instance hostname
    const projectId = await gcpMetadata.project('project-id');
    console.log(projectId); // ...Project ID of the running instance

    Access nested properties with the relative path

    const data = await gcpMetadata.instance('service-accounts/default/email');
    console.log(data); // ...Email address of the Compute identity service account

    Access specific properties with query parameters

    const data = await gcpMetadata.instance({
      property: 'tags',
      params: { alt: 'text' }
    console.log(data) // ...Tags as newline-delimited list

    Access with custom headers

    await gcpMetadata.instance({
      headers: { 'no-trace': '1' }
    }); // ...Request is untraced

    Take care with large number valued properties

    In some cases number valued properties returned by the Metadata Service may be too large to be representable as JavaScript numbers. In such cases we return those values as BigNumber objects (from the bignumber.js library). Numbers that fit within the JavaScript number range will be returned as normal number values.

    const id = await gcpMetadata.instance('id');
    console.log(id)  // ... BigNumber { s: 1, e: 18, c: [ 45200, 31799277581759 ] }
    console.log(id.toString()) // ... 4520031799277581759

    Environment variables

    • GCE_METADATA_HOST: provide an alternate host or IP to perform lookup against (useful, for example, you're connecting through a custom proxy server).

    For example:

    export GCE_METADATA_HOST = ''
    • DETECT_GCP_RETRIES: number representing number of retries that should be attempted on metadata lookup.


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

    Sample Source Code Try it
    Quickstart source code Open in Cloud Shell

    The GCP Metadata 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 gcp-metadata@legacy-8 installs client libraries for versions compatible with Node.js 8.


    This library follows Semantic Versioning.

    This library is considered to be General Availability (GA). This means it is 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 GA 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



    npm i gcp-metadata

    DownloadsWeekly Downloads






    Unpacked Size

    60.2 kB

    Total Files


    Last publish


    • google-wombot
    • stephenplusplus
    • google-cloud-admin