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:

Quickstart

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 = {
    parent,
  };

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

callListKeys();

Samples

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

Sample Source Code Try it
Api_keys.create_key source code Open in Cloud Shell
Api_keys.delete_key source code Open in Cloud Shell
Api_keys.get_key source code Open in Cloud Shell
Api_keys.get_key_string source code Open in Cloud Shell
Api_keys.list_keys source code Open in Cloud Shell
Api_keys.lookup_key source code Open in Cloud Shell
Api_keys.undelete_key source code