Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)



API Reference

This guide contains technical reference information for the Google Cloud Storage JSON API. Like the XML API , it is RESTful, but it has slightly different URI endpoints and request syntax, and is specifically intended to be used with the Google API client libraries .

This API reference is organized by resource type. Each resource type has one or more data representations and one or more methods.

Resource types

  1. BucketAccessControls
  2. Buckets
  3. ObjectAccessControls
  4. Objects
  5. DefaultObjectAccessControls
  6. Channels

BucketAccessControls

For BucketAccessControls Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/storage/v1, unless otherwise noted
delete DELETE  /b/ bucket /acl/ entity Permanently deletes the ACL entry for the specified entity on the specified bucket .
get GET  /b/ bucket /acl/ entity Returns the ACL entry for the specified entity on the specified bucket.
insert POST  /b/ bucket /acl Creates a new ACL entry on the specified bucket .
list GET  /b/ bucket /acl Retrieves ACL entries on a specified bucket .
patch PATCH  /b/ bucket /acl/ entity Updates an ACL entry on the specified bucket . This method supports patch semantics.
update PUT  /b/ bucket /acl/ entity Updates an ACL entry on the specified bucket .

Buckets

For Buckets Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/storage/v1, unless otherwise noted
delete DELETE  /b/ bucket Permanently deletes an empty bucket.
get GET  /b/ bucket Returns metadata for the specified bucket.
insert POST  /b Creates a new bucket.

Required query parameters: project
list GET  /b Retrieves a list of buckets for a given project.

Required query parameters: project
patch PATCH  /b/ bucket Updates a bucket. This method supports patch semantics.
update PUT  /b/ bucket Updates a bucket.

ObjectAccessControls

For ObjectAccessControls Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/storage/v1, unless otherwise noted
delete DELETE  /b/ bucket /o/ object /acl/ entity Permanently deletes the ACL entry for the specified entity on the specified object .
get GET  /b/ bucket /o/ object /acl/ entity Returns the ACL entry for the specified entity on the specified object .
insert POST  /b/ bucket /o/ object /acl Creates a new ACL entry on the specified object .
list GET  /b/ bucket /o/ object /acl Retrieves ACL entries on the specified object .
patch PATCH  /b/ bucket /o/ object /acl/ entity Updates an ACL entry on the specified object . This method supports patch semantics.
update PUT  /b/ bucket /o/ object /acl/ entity Updates an ACL entry on the specified object .

Objects

For Objects Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/storage/v1, unless otherwise noted
compose POST  /b/ destinationBucket /o/ destinationObject /compose Concatenates a list of existing objects into a new object in the same bucket.
copy POST  /b/ sourceBucket /o/ sourceObject /copyTo/b/ destinationBucket /o/ destinationObject Copies an object to a specified location. Optionally overrides metadata.
delete DELETE  /b/ bucket /o/ object Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.
get GET  /b/ bucket /o/ object Retrieves objects or their metadata.
insert POST
https://www.googleapis.com/upload/storage/v1/b/ bucket /o
and
POST  /b/ bucket /o 		Stores a new object and metadata.
list GET  /b/ bucket /o Retrieves a list of objects matching the criteria.
patch PATCH  /b/ bucket /o/ object Updates a data blob's associated metadata. This method supports patch semantics.
update PUT  /b/ bucket /o/ object Updates an object's metadata.
watchAll POST  /b/ bucket /o/watch Watch for changes on all objects in a bucket.

DefaultObjectAccessControls

For DefaultObjectAccessControls Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/storage/v1, unless otherwise noted
delete DELETE  /b/ bucket /defaultObjectAcl/ entity Permanently deletes the default object ACL entry for the specified entity on the specified bucket .
get GET  /b/ bucket /defaultObjectAcl/ entity Returns the default object ACL entry for the specified entity on the specified bucket .
insert POST  /b/ bucket /defaultObjectAcl Creates a new default object ACL entry on the specified bucket .
list GET  /b/ bucket /defaultObjectAcl Retrieves default object ACL entries on the specified bucket .
patch PATCH  /b/ bucket /defaultObjectAcl/ entity Updates a default object ACL entry on the specified bucket . This method supports patch semantics.
update PUT  /b/ bucket /defaultObjectAcl/ entity Updates a default object ACL entry on the specified bucket .

Channels

For Channels Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/storage/v1, unless otherwise noted
stop POST  /channels/stop Stop receiving object change notifications through this channel.


Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License , and code samples are licensed under the Apache 2.0 License . For details, see our Site Policies .

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.