API Keys API: Node.js Client

release level npm version

API Keys API client for Node.js

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 API Keys API 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/apikeys

Using the client library

 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 *  Required. Lists all API keys associated with this project.
// const parent = 'abc123'
 *  Optional. Specifies the maximum number of results to be returned at a time.
// const pageSize = 1234
 *  Optional. Requests a specific page of results.
// const pageToken = 'abc123'
 *  Optional. Indicate that keys deleted in the past 30 days should also be
 *  returned.
// const showDeleted = true

// Imports the Apikeys library
const {ApiKeysClient} = require('@google-cloud/apikeys').v2;

// Instantiates a client
const apikeysClient = new ApiKeysClient();

async function callListKeys() {
  // Construct request
  const request = {

  // Run request
  const iterable = await apikeysClient.listKeysAsync(request);
  for await (const response of iterable) {



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

SampleSource CodeTry it
Api_keys.create_keysource codeOpen in Cloud Shell
Api_keys.delete_keysource codeOpen in Cloud Shell
Api_keys.get_keysource codeOpen in Cloud Shell
Api_keys.get_key_stringsource codeOpen in Cloud Shell
Api_keys.list_keyssource codeOpen in Cloud Shell
Api_keys.lookup_keysource codeOpen in Cloud Shell
Api_keys.undelete_keysource codeOpen in Cloud Shell
Api_keys.update_keysource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

The API Keys API 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/apikeys@legacy-8 installs client libraries for versions compatible with Node.js 8.


This library follows Semantic Versioning.

This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

More Information: Google Cloud Platform Launch Stages


Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, 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