Google Cloud Platform logo

Google Cloud Storage: Node.js Client

release level CircleCI AppVeyor codecov

Node.js idiomatic client for Cloud Storage .

Client API Reference


Before you begin

  1. Select or create a Cloud Platform project.

    Go to the projects page

  2. Enable billing for your project.

    Enable billing

  3. Enable the Google Cloud Storage API.

    Enable the 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 --save @google-cloud/storage

Using the client library

// Imports the Google Cloud client library
const Storage = require('@google-cloud/storage');

// Your Google Cloud Platform project ID
const projectId = 'YOUR_PROJECT_ID';

// Instantiates a client
const storage = Storage({
  projectId: projectId,

// The name for the new bucket
const bucketName = 'my-new-bucket';

// Creates the new bucket
  .then(() => {
    console.log(`Bucket ${bucketName} created.`);
  .catch(err => {
    console.error('ERROR:', err);


Samples are in the samples/ directory. The samples' has instructions for running the samples.

Sample Documentation Source Code
ACL (Access Control Lists) documentation source code
Buckets documentation source code
Encryption documentation source code
Files documentation source code
Requester Pays documentation source code


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.

Please note that the auto-generated portions of the GA libraries (the ones in modules such as v1 or v2 ) are considered to be of Beta quality, even if the libraries that wrap them are GA .

More Information: Google Cloud Platform Launch Stages


Contributions welcome! See the Contributing Guide .


Apache Version 2.0