Cloud Storage API: Node.js Client

release level npm version

Cloud Storage 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 Cloud Storage 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/storage-control

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. Name of the bucket for which to get the layout
// const bucketName = 'abc123'

// Imports the Control library
const {StorageControlClient} = require('@google-cloud/storage-control').v2;

// Instantiates a client
const controlClient = new StorageControlClient();

async function callGetStorageLayout() {
  // Construct request
  const request = {
    name: `projects/_/buckets/${bucketName}/storageLayout`,

  // Run request
  const [layout] = await controlClient.getStorageLayout(request);

  // Use response
    `Bucket ${bucketName} has location type ${layout.locationType}.`



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

Sample Source Code Try it
Storage_control.create_folder source code Open in Cloud Shell
Storage_control.create_managed_folder source code Open in Cloud Shell
Storage_control.delete_folder source code Open in Cloud Shell
Storage_control.delete_managed_folder source code Open in Cloud Shell
Storage_control.get_folder source code Open in Cloud Shell
Storage_control.get_managed_folder source code Open in Cloud Shell
Storage_control.get_storage_layout source code Open in Cloud Shell
Storage_control.list_folders source code Open in Cloud Shell
Storage_control.list_managed_folders source code Open in Cloud Shell
Storage_control.rename_folder source code Open in Cloud Shell
Quickstart source code Open in Cloud Shell

The Cloud Storage 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/storage-control@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, 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