Google - API Cloud Storage

DELETE

/b/{bucket}/acl/{entity}

Permanently deletes the ACL entry for the specified entity on the specified bucket.

Request

Path

Name	Data Type	Description
`entity`	string	The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.

Responses

200Successful response

GET

/b/{bucket}/acl/{entity}

Returns the ACL entry for the specified entity on the specified bucket.

Request

Path

Name	Data Type	Description
`entity`	string	The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.

Responses

200Successful response

Body

Name Data Type Description

BucketAccessControl


                        BucketAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`kind`	string Default value: `storage#bucketAccessControl`	The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
`id`	string	The ID of the access-control entry.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

PATCH

/b/{bucket}/acl/{entity}

Patches an ACL entry on the specified bucket.

Request

Path

Name	Data Type	Description
`entity`	string	The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.

Body

Name Data Type Description

BucketAccessControl


                        BucketAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`kind`	string Default value: `storage#bucketAccessControl`	The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
`id`	string	The ID of the access-control entry.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

Responses

200Successful response

Body

Name Data Type Description

BucketAccessControl


                        BucketAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`kind`	string Default value: `storage#bucketAccessControl`	The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
`id`	string	The ID of the access-control entry.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

PUT

/b/{bucket}/acl/{entity}

Updates an ACL entry on the specified bucket.

Request

Path

Name	Data Type	Description
`entity`	string	The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.

Body

Name Data Type Description

BucketAccessControl


                        BucketAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`kind`	string Default value: `storage#bucketAccessControl`	The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
`id`	string	The ID of the access-control entry.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

Responses

200Successful response

Body

Name Data Type Description

BucketAccessControl


                        BucketAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`kind`	string Default value: `storage#bucketAccessControl`	The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
`id`	string	The ID of the access-control entry.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

GET

/b/{bucket}/acl

Retrieves ACL entries on the specified bucket.

Request

Path

Name	Data Type	Description
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.

Responses

200Successful response

Body

Name Data Type Description

BucketAccessControls


                        BucketAccessControls

object

An access-control list.

Properties


                        kind

string
Default value: storage#bucketAccessControls

The kind of item this is. For lists of bucket access control entries, this is always storage#bucketAccessControls.


                        items

array [BucketAccessControl]

The list of items.


                        BucketAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`kind`	string Default value: `storage#bucketAccessControl`	The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
`id`	string	The ID of the access-control entry.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

POST

/b/{bucket}/acl

Creates a new ACL entry on the specified bucket.

Request

Path

Name	Data Type	Description
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.

Body

Name Data Type Description

BucketAccessControl


                        BucketAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`kind`	string Default value: `storage#bucketAccessControl`	The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
`id`	string	The ID of the access-control entry.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

Responses

200Successful response

Body

Name Data Type Description

BucketAccessControl


                        BucketAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`kind`	string Default value: `storage#bucketAccessControl`	The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
`id`	string	The ID of the access-control entry.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

GET

/b/{bucket}/iam/testPermissions

Tests a set of permissions on the given bucket to see which, if any, are held by the caller.

Request

Path

Name	Data Type	Description
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`permissions`	array	Permissions to test.

Responses

200Successful response

Body

Name Data Type Description

TestIamPermissionsResponse


                        TestIamPermissionsResponse

object

A storage.(buckets|objects).testIamPermissions response.

Properties

`permissions`	array [string]	The permissions held by the caller. Permissions are always of the format storage.resource.capability, where resource is one of buckets or objects. The supported permissions are as follows: storage.buckets.delete — Delete bucket. storage.buckets.get — Read bucket metadata. storage.buckets.getIamPolicy — Read bucket IAM policy. storage.buckets.create — Create bucket. storage.buckets.list — List buckets. storage.buckets.setIamPolicy — Update bucket IAM policy. storage.buckets.update — Update bucket metadata. storage.objects.delete — Delete object. storage.objects.get — Read object data and metadata. storage.objects.getIamPolicy — Read object IAM policy. storage.objects.create — Create object. storage.objects.list — List objects. storage.objects.setIamPolicy — Update object IAM policy. storage.objects.update — Update object metadata.
`kind`	string Default value: `storage#testIamPermissionsResponse`	The kind of item this is.

GET

/b/{bucket}/iam

Returns an IAM policy for the specified bucket.

Request

Path

Name	Data Type	Description
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`optionsRequestedPolicyVersion`	integer Minimum: 1	The IAM policy format version to be returned. If the optionsRequestedPolicyVersion is for an older version that doesn't support part of the requested IAM policy, the request fails.

Responses

200Successful response

Body

Name Data Type Description

Policy


                        Policy

object

A bucket/object IAM policy.

Properties

`version`	integer	The IAM policy format version.
`resourceId`	string	The ID of the resource to which this policy belongs. Will be of the form projects//buckets/bucket for buckets, and projects//buckets/bucket/objects/object for objects. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input.
`kind`	string Default value: `storage#policy`	The kind of item this is. For policies, this is always storage#policy. This field is ignored on input.
`etag`	byte	HTTP 1.1 Entity tag for the policy.
`bindings`	array [object]	An association between a role, which comes with a set of permissions, and members who may assume that role.

PUT

/b/{bucket}/iam

Updates an IAM policy for the specified bucket.

Request

Path

Name	Data Type	Description
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.

Body

Name Data Type Description

Policy


                        Policy

object

A bucket/object IAM policy.

Properties

`version`	integer	The IAM policy format version.
`resourceId`	string	The ID of the resource to which this policy belongs. Will be of the form projects//buckets/bucket for buckets, and projects//buckets/bucket/objects/object for objects. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input.
`kind`	string Default value: `storage#policy`	The kind of item this is. For policies, this is always storage#policy. This field is ignored on input.
`etag`	byte	HTTP 1.1 Entity tag for the policy.
`bindings`	array [object]	An association between a role, which comes with a set of permissions, and members who may assume that role.

Responses

200Successful response

Body

Name Data Type Description

Policy


                        Policy

object

A bucket/object IAM policy.

Properties

`version`	integer	The IAM policy format version.
`resourceId`	string	The ID of the resource to which this policy belongs. Will be of the form projects//buckets/bucket for buckets, and projects//buckets/bucket/objects/object for objects. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input.
`kind`	string Default value: `storage#policy`	The kind of item this is. For policies, this is always storage#policy. This field is ignored on input.
`etag`	byte	HTTP 1.1 Entity tag for the policy.
`bindings`	array [object]	An association between a role, which comes with a set of permissions, and members who may assume that role.

POST

/b/{bucket}/lockRetentionPolicy

Locks retention policy on a bucket.

Request

Path

Name	Data Type	Description
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`ifMetagenerationMatch`	string	Makes the operation conditional on whether bucket's current metageneration matches the given value.

Responses

200Successful response

Body

Name Data Type Description

Bucket


                        Bucket

object

A bucket.

Properties

website

versioning


                        updated

dateTime

The modification time of the bucket in RFC 3339 format.


                        timeCreated

dateTime

The creation time of the bucket in RFC 3339 format.


                        storageClass

string

The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.


                        selfLink

string

The URI of this bucket.

retentionPolicy


                        projectNumber

string

The project number of the project the bucket belongs to.

owner


                        name

string

The name of the bucket.


                        metageneration

string

The metadata generation of this bucket.

logging


                        locationType

string

The type of the bucket location.


                        location

string

The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.

lifecycle


                        labels

object

User-provided labels, in key/value pairs.


                        kind

string
Default value: storage#bucket

The kind of item this is. For buckets, this is always storage#bucket.

id

string

The ID of the bucket. For buckets, the id and name properties are the same.

iamConfiguration


                        etag

string

HTTP 1.1 Entity tag for the bucket.

encryption


                        defaultObjectAcl

array [ObjectAccessControl]

Default access controls to apply to new objects when no ACL is provided.


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.


                        defaultEventBasedHold

boolean

The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.


                        cors

array [object]

The bucket's Cross-Origin Resource Sharing (CORS) configuration.

billing

acl

array [BucketAccessControl]

Access controls on the bucket.


                        BucketAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`kind`	string Default value: `storage#bucketAccessControl`	The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
`id`	string	The ID of the access-control entry.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

DELETE

/b/{bucket}

Permanently deletes an empty bucket.

Request

Path

Name	Data Type	Description
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`ifMetagenerationNotMatch`	string	If set, only deletes the bucket if its metageneration does not match this value.
`ifMetagenerationMatch`	string	If set, only deletes the bucket if its metageneration matches this value.

Responses

200Successful response

GET

/b/{bucket}

Returns metadata for the specified bucket.

Request

Path

Name	Data Type	Description
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`projection`	string Allowed values: - `full` - `noAcl`	Set of properties to return. Defaults to noAcl.
`ifMetagenerationNotMatch`	string	Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
`ifMetagenerationMatch`	string	Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.

Responses

200Successful response

Body

Name Data Type Description

Bucket


                        Bucket

object

A bucket.

Properties

website

versioning


                        updated

dateTime

The modification time of the bucket in RFC 3339 format.


                        timeCreated

dateTime

The creation time of the bucket in RFC 3339 format.


                        storageClass

string

The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.


                        selfLink

string

The URI of this bucket.

retentionPolicy


                        projectNumber

string

The project number of the project the bucket belongs to.

owner


                        name

string

The name of the bucket.


                        metageneration

string

The metadata generation of this bucket.

logging


                        locationType

string

The type of the bucket location.


                        location

string

The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.

lifecycle


                        labels

object

User-provided labels, in key/value pairs.


                        kind

string
Default value: storage#bucket

The kind of item this is. For buckets, this is always storage#bucket.

id

string

The ID of the bucket. For buckets, the id and name properties are the same.

iamConfiguration


                        etag

string

HTTP 1.1 Entity tag for the bucket.

encryption


                        defaultObjectAcl

array [ObjectAccessControl]

Default access controls to apply to new objects when no ACL is provided.


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.


                        defaultEventBasedHold

boolean

The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.


                        cors

array [object]

The bucket's Cross-Origin Resource Sharing (CORS) configuration.

billing

acl

array [BucketAccessControl]

Access controls on the bucket.


                        BucketAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`kind`	string Default value: `storage#bucketAccessControl`	The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
`id`	string	The ID of the access-control entry.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

PATCH

/b/{bucket}

Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.

Request

Path

Name	Data Type	Description
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`projection`	string Allowed values: - `full` - `noAcl`	Set of properties to return. Defaults to full.
`predefinedDefaultObjectAcl`	string Allowed values: - `authenticatedRead` - `bucketOwnerFullControl` - `bucketOwnerRead` - `private` - `projectPrivate` - `publicRead`	Apply a predefined set of default object access controls to this bucket.
`predefinedAcl`	string Allowed values: - `authenticatedRead` - `private` - `projectPrivate` - `publicRead` - `publicReadWrite`	Apply a predefined set of access controls to this bucket.
`ifMetagenerationNotMatch`	string	Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
`ifMetagenerationMatch`	string	Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.

Body

Name Data Type Description

Bucket


                        Bucket

object

A bucket.

Properties

website

versioning


                        updated

dateTime

The modification time of the bucket in RFC 3339 format.


                        timeCreated

dateTime

The creation time of the bucket in RFC 3339 format.


                        storageClass

string

The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.


                        selfLink

string

The URI of this bucket.

retentionPolicy


                        projectNumber

string

The project number of the project the bucket belongs to.

owner


                        name

string

The name of the bucket.


                        metageneration

string

The metadata generation of this bucket.

logging


                        locationType

string

The type of the bucket location.


                        location

string

The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.

lifecycle


                        labels

object

User-provided labels, in key/value pairs.


                        kind

string
Default value: storage#bucket

The kind of item this is. For buckets, this is always storage#bucket.

id

string

The ID of the bucket. For buckets, the id and name properties are the same.

iamConfiguration


                        etag

string

HTTP 1.1 Entity tag for the bucket.

encryption


                        defaultObjectAcl

array [ObjectAccessControl]

Default access controls to apply to new objects when no ACL is provided.


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.


                        defaultEventBasedHold

boolean

The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.


                        cors

array [object]

The bucket's Cross-Origin Resource Sharing (CORS) configuration.

billing

acl

array [BucketAccessControl]

Access controls on the bucket.


                        BucketAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`kind`	string Default value: `storage#bucketAccessControl`	The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
`id`	string	The ID of the access-control entry.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

Responses

200Successful response

Body

Name Data Type Description

Bucket


                        Bucket

object

A bucket.

Properties

website

versioning


                        updated

dateTime

The modification time of the bucket in RFC 3339 format.


                        timeCreated

dateTime

The creation time of the bucket in RFC 3339 format.


                        storageClass

string

The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.


                        selfLink

string

The URI of this bucket.

retentionPolicy


                        projectNumber

string

The project number of the project the bucket belongs to.

owner


                        name

string

The name of the bucket.


                        metageneration

string

The metadata generation of this bucket.

logging


                        locationType

string

The type of the bucket location.


                        location

string

The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.

lifecycle


                        labels

object

User-provided labels, in key/value pairs.


                        kind

string
Default value: storage#bucket

The kind of item this is. For buckets, this is always storage#bucket.

id

string

The ID of the bucket. For buckets, the id and name properties are the same.

iamConfiguration


                        etag

string

HTTP 1.1 Entity tag for the bucket.

encryption


                        defaultObjectAcl

array [ObjectAccessControl]

Default access controls to apply to new objects when no ACL is provided.


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.


                        defaultEventBasedHold

boolean

The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.


                        cors

array [object]

The bucket's Cross-Origin Resource Sharing (CORS) configuration.

billing

acl

array [BucketAccessControl]

Access controls on the bucket.


                        BucketAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`kind`	string Default value: `storage#bucketAccessControl`	The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
`id`	string	The ID of the access-control entry.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

PUT

/b/{bucket}

Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.

Request

Path

Name	Data Type	Description
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`projection`	string Allowed values: - `full` - `noAcl`	Set of properties to return. Defaults to full.
`predefinedDefaultObjectAcl`	string Allowed values: - `authenticatedRead` - `bucketOwnerFullControl` - `bucketOwnerRead` - `private` - `projectPrivate` - `publicRead`	Apply a predefined set of default object access controls to this bucket.
`predefinedAcl`	string Allowed values: - `authenticatedRead` - `private` - `projectPrivate` - `publicRead` - `publicReadWrite`	Apply a predefined set of access controls to this bucket.
`ifMetagenerationNotMatch`	string	Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
`ifMetagenerationMatch`	string	Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.

Body

Name Data Type Description

Bucket


                        Bucket

object

A bucket.

Properties

website

versioning


                        updated

dateTime

The modification time of the bucket in RFC 3339 format.


                        timeCreated

dateTime

The creation time of the bucket in RFC 3339 format.


                        storageClass

string

The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.


                        selfLink

string

The URI of this bucket.

retentionPolicy


                        projectNumber

string

The project number of the project the bucket belongs to.

owner


                        name

string

The name of the bucket.


                        metageneration

string

The metadata generation of this bucket.

logging


                        locationType

string

The type of the bucket location.


                        location

string

The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.

lifecycle


                        labels

object

User-provided labels, in key/value pairs.


                        kind

string
Default value: storage#bucket

The kind of item this is. For buckets, this is always storage#bucket.

id

string

The ID of the bucket. For buckets, the id and name properties are the same.

iamConfiguration


                        etag

string

HTTP 1.1 Entity tag for the bucket.

encryption


                        defaultObjectAcl

array [ObjectAccessControl]

Default access controls to apply to new objects when no ACL is provided.


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.


                        defaultEventBasedHold

boolean

The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.


                        cors

array [object]

The bucket's Cross-Origin Resource Sharing (CORS) configuration.

billing

acl

array [BucketAccessControl]

Access controls on the bucket.


                        BucketAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`kind`	string Default value: `storage#bucketAccessControl`	The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
`id`	string	The ID of the access-control entry.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

Responses

200Successful response

Body

Name Data Type Description

Bucket


                        Bucket

object

A bucket.

Properties

website

versioning


                        updated

dateTime

The modification time of the bucket in RFC 3339 format.


                        timeCreated

dateTime

The creation time of the bucket in RFC 3339 format.


                        storageClass

string

The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.


                        selfLink

string

The URI of this bucket.

retentionPolicy


                        projectNumber

string

The project number of the project the bucket belongs to.

owner


                        name

string

The name of the bucket.


                        metageneration

string

The metadata generation of this bucket.

logging


                        locationType

string

The type of the bucket location.


                        location

string

The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.

lifecycle


                        labels

object

User-provided labels, in key/value pairs.


                        kind

string
Default value: storage#bucket

The kind of item this is. For buckets, this is always storage#bucket.

id

string

The ID of the bucket. For buckets, the id and name properties are the same.

iamConfiguration


                        etag

string

HTTP 1.1 Entity tag for the bucket.

encryption


                        defaultObjectAcl

array [ObjectAccessControl]

Default access controls to apply to new objects when no ACL is provided.


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.


                        defaultEventBasedHold

boolean

The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.


                        cors

array [object]

The bucket's Cross-Origin Resource Sharing (CORS) configuration.

billing

acl

array [BucketAccessControl]

Access controls on the bucket.


                        BucketAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`kind`	string Default value: `storage#bucketAccessControl`	The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
`id`	string	The ID of the access-control entry.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

GET

/b

Retrieves a list of buckets for a given project.

Request

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`projection`	string Allowed values: - `full` - `noAcl`	Set of properties to return. Defaults to noAcl.
`prefix`	string	Filter results to buckets whose names begin with this prefix.
`pageToken`	string	A previously-returned page token representing part of the larger set of results to view.
`maxResults`	integer Default value: `1000` Minimum: 0	Maximum number of buckets to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.
`project`	string	A valid API project identifier.

Responses

200Successful response

Body

Name Data Type Description

Buckets


                        Buckets

object

A list of buckets.

Properties


                        nextPageToken

string

The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.


                        kind

string
Default value: storage#buckets

The kind of item this is. For lists of buckets, this is always storage#buckets.


                        items

array [Bucket]

The list of items.


                        Bucket

object

A bucket.

Properties

`website`
`versioning`
`updated`	dateTime	The modification time of the bucket in RFC 3339 format.
`timeCreated`	dateTime	The creation time of the bucket in RFC 3339 format.
`storageClass`	string	The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
`selfLink`	string	The URI of this bucket.
`retentionPolicy`
`projectNumber`	string	The project number of the project the bucket belongs to.
`owner`
`name`	string	The name of the bucket.
`metageneration`	string	The metadata generation of this bucket.
`logging`
`locationType`	string	The type of the bucket location.
`location`	string	The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.
`lifecycle`
`labels`	object	User-provided labels, in key/value pairs.
`kind`	string Default value: `storage#bucket`	The kind of item this is. For buckets, this is always storage#bucket.
`id`	string	The ID of the bucket. For buckets, the id and name properties are the same.
`iamConfiguration`
`etag`	string	HTTP 1.1 Entity tag for the bucket.
`encryption`
`defaultObjectAcl`	array [ObjectAccessControl]	Default access controls to apply to new objects when no ACL is provided.
`defaultEventBasedHold`	boolean	The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.
`cors`	array [object]	The bucket's Cross-Origin Resource Sharing (CORS) configuration.
`billing`
`acl`	array [BucketAccessControl]	Access controls on the bucket.

POST

/b

Creates a new bucket.

Request

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`projection`	string Allowed values: - `full` - `noAcl`	Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full.
`predefinedDefaultObjectAcl`	string Allowed values: - `authenticatedRead` - `bucketOwnerFullControl` - `bucketOwnerRead` - `private` - `projectPrivate` - `publicRead`	Apply a predefined set of default object access controls to this bucket.
`predefinedAcl`	string Allowed values: - `authenticatedRead` - `private` - `projectPrivate` - `publicRead` - `publicReadWrite`	Apply a predefined set of access controls to this bucket.
`project`	string	A valid API project identifier.

Body

Responses

200Successful response

Body

Name Data Type Description

Bucket


                        Bucket

object

A bucket.

Properties

website

versioning


                        updated

dateTime

The modification time of the bucket in RFC 3339 format.


                        timeCreated

dateTime

The creation time of the bucket in RFC 3339 format.


                        storageClass

string

The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.


                        selfLink

string

The URI of this bucket.

retentionPolicy


                        projectNumber

string

The project number of the project the bucket belongs to.

owner


                        name

string

The name of the bucket.


                        metageneration

string

The metadata generation of this bucket.

logging


                        locationType

string

The type of the bucket location.


                        location

string

The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.

lifecycle


                        labels

object

User-provided labels, in key/value pairs.


                        kind

string
Default value: storage#bucket

The kind of item this is. For buckets, this is always storage#bucket.

id

string

The ID of the bucket. For buckets, the id and name properties are the same.

iamConfiguration


                        etag

string

HTTP 1.1 Entity tag for the bucket.

encryption


                        defaultObjectAcl

array [ObjectAccessControl]

Default access controls to apply to new objects when no ACL is provided.


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.


                        defaultEventBasedHold

boolean

The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.


                        cors

array [object]

The bucket's Cross-Origin Resource Sharing (CORS) configuration.

billing

acl

array [BucketAccessControl]

Access controls on the bucket.


                        BucketAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`kind`	string Default value: `storage#bucketAccessControl`	The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
`id`	string	The ID of the access-control entry.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

POST

/channels/stop

DELETE

/b/{bucket}/defaultObjectAcl/{entity}

Permanently deletes the default object ACL entry for the specified entity on the specified bucket.

Request

Path

Name	Data Type	Description
`entity`	string	The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.

Responses

200Successful response

GET

/b/{bucket}/defaultObjectAcl/{entity}

Returns the default object ACL entry for the specified entity on the specified bucket.

Request

Path

Name	Data Type	Description
`entity`	string	The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.

Responses

200Successful response

Body

Name Data Type Description

ObjectAccessControl


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

PATCH

/b/{bucket}/defaultObjectAcl/{entity}

Patches a default object ACL entry on the specified bucket.

Request

Path

Name	Data Type	Description
`entity`	string	The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.

Body

Name Data Type Description

ObjectAccessControl


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

Responses

200Successful response

Body

Name Data Type Description

ObjectAccessControl


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

PUT

/b/{bucket}/defaultObjectAcl/{entity}

Updates a default object ACL entry on the specified bucket.

Request

Path

Name	Data Type	Description
`entity`	string	The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.

Body

Name Data Type Description

ObjectAccessControl


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

Responses

200Successful response

Body

Name Data Type Description

ObjectAccessControl


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

GET

/b/{bucket}/defaultObjectAcl

Retrieves default object ACL entries on the specified bucket.

Request

Path

Name	Data Type	Description
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`ifMetagenerationNotMatch`	string	If present, only return default ACL listing if the bucket's current metageneration does not match the given value.
`ifMetagenerationMatch`	string	If present, only return default ACL listing if the bucket's current metageneration matches this value.

Responses

200Successful response

Body

Name Data Type Description

ObjectAccessControls


                        ObjectAccessControls

object

An access-control list.

Properties


                        kind

string
Default value: storage#objectAccessControls

The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls.


                        items

array [ObjectAccessControl]

The list of items.


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

POST

/b/{bucket}/defaultObjectAcl

Creates a new default object ACL entry on the specified bucket.

Request

Path

Name	Data Type	Description
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.

Body

Name Data Type Description

ObjectAccessControl


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

Responses

200Successful response

Body

Name Data Type Description

ObjectAccessControl


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

DELETE

/b/{bucket}/notificationConfigs/{notification}

Permanently deletes a notification subscription.

Request

Path

Name	Data Type	Description
`notification`	string	ID of the notification to delete.
`bucket`	string	The parent bucket of the notification.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.

Responses

200Successful response

GET

/b/{bucket}/notificationConfigs/{notification}

View a notification configuration.

Request

Path

Name	Data Type	Description
`notification`	string	Notification ID
`bucket`	string	The parent bucket of the notification.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.

Responses

200Successful response

Body

Name Data Type Description

Notification


                        Notification

object

A subscription to receive Google PubSub notifications.

Properties

`topic`	string	The Cloud PubSub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}'
`selfLink`	string	The canonical URL of this notification.
`payload_format`	string Default value: `JSON_API_V1`	The desired content of the Payload.
`object_name_prefix`	string	If present, only apply this notification configuration to object names that begin with this prefix.
`kind`	string Default value: `storage#notification`	The kind of item this is. For notifications, this is always storage#notification.
`id`	string	The ID of the notification.
`event_types`	array [string]	If present, only send notifications about listed event types. If empty, sent notifications for all event types.
`etag`	string	HTTP 1.1 Entity tag for this subscription notification.
`custom_attributes`	object	An optional list of additional attributes to attach to each Cloud PubSub message published for this notification subscription.

GET

/b/{bucket}/notificationConfigs

Retrieves a list of notification subscriptions for a given bucket.

Request

Path

Name	Data Type	Description
`bucket`	string	Name of a Google Cloud Storage bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.

Responses

200Successful response

Body

Name Data Type Description

Notifications


                        Notifications

object

A list of notification subscriptions.

Properties


                        kind

string
Default value: storage#notifications

The kind of item this is. For lists of notifications, this is always storage#notifications.


                        items

array [Notification]

The list of items.


                        Notification

object

A subscription to receive Google PubSub notifications.

Properties

`topic`	string	The Cloud PubSub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}'
`selfLink`	string	The canonical URL of this notification.
`payload_format`	string Default value: `JSON_API_V1`	The desired content of the Payload.
`object_name_prefix`	string	If present, only apply this notification configuration to object names that begin with this prefix.
`kind`	string Default value: `storage#notification`	The kind of item this is. For notifications, this is always storage#notification.
`id`	string	The ID of the notification.
`event_types`	array [string]	If present, only send notifications about listed event types. If empty, sent notifications for all event types.
`etag`	string	HTTP 1.1 Entity tag for this subscription notification.
`custom_attributes`	object	An optional list of additional attributes to attach to each Cloud PubSub message published for this notification subscription.

POST

/b/{bucket}/notificationConfigs

Creates a notification subscription for a given bucket.

Request

Path

Name	Data Type	Description
`bucket`	string	The parent bucket of the notification.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.

Body

Name Data Type Description

Notification


                        Notification

object

A subscription to receive Google PubSub notifications.

Properties

`topic`	string	The Cloud PubSub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}'
`selfLink`	string	The canonical URL of this notification.
`payload_format`	string Default value: `JSON_API_V1`	The desired content of the Payload.
`object_name_prefix`	string	If present, only apply this notification configuration to object names that begin with this prefix.
`kind`	string Default value: `storage#notification`	The kind of item this is. For notifications, this is always storage#notification.
`id`	string	The ID of the notification.
`event_types`	array [string]	If present, only send notifications about listed event types. If empty, sent notifications for all event types.
`etag`	string	HTTP 1.1 Entity tag for this subscription notification.
`custom_attributes`	object	An optional list of additional attributes to attach to each Cloud PubSub message published for this notification subscription.

Responses

200Successful response

Body

Name Data Type Description

Notification


                        Notification

object

A subscription to receive Google PubSub notifications.

Properties

`topic`	string	The Cloud PubSub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}'
`selfLink`	string	The canonical URL of this notification.
`payload_format`	string Default value: `JSON_API_V1`	The desired content of the Payload.
`object_name_prefix`	string	If present, only apply this notification configuration to object names that begin with this prefix.
`kind`	string Default value: `storage#notification`	The kind of item this is. For notifications, this is always storage#notification.
`id`	string	The ID of the notification.
`event_types`	array [string]	If present, only send notifications about listed event types. If empty, sent notifications for all event types.
`etag`	string	HTTP 1.1 Entity tag for this subscription notification.
`custom_attributes`	object	An optional list of additional attributes to attach to each Cloud PubSub message published for this notification subscription.

DELETE

/b/{bucket}/o/{object}/acl/{entity}

Permanently deletes the ACL entry for the specified entity on the specified object.

Request

Path

Name	Data Type	Description
`entity`	string	The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
`object`	string	Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`generation`	string	If present, selects a specific revision of this object (as opposed to the latest version, the default).

Responses

200Successful response

GET

/b/{bucket}/o/{object}/acl/{entity}

Returns the ACL entry for the specified entity on the specified object.

Request

Path

Name	Data Type	Description
`entity`	string	The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
`object`	string	Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`generation`	string	If present, selects a specific revision of this object (as opposed to the latest version, the default).

Responses

200Successful response

Body

Name Data Type Description

ObjectAccessControl


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

PATCH

/b/{bucket}/o/{object}/acl/{entity}

Patches an ACL entry on the specified object.

Request

Path

Name	Data Type	Description
`entity`	string	The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
`object`	string	Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`generation`	string	If present, selects a specific revision of this object (as opposed to the latest version, the default).

Body

Name Data Type Description

ObjectAccessControl


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

Responses

200Successful response

Body

Name Data Type Description

ObjectAccessControl


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

PUT

/b/{bucket}/o/{object}/acl/{entity}

Updates an ACL entry on the specified object.

Request

Path

Name	Data Type	Description
`entity`	string	The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
`object`	string	Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`generation`	string	If present, selects a specific revision of this object (as opposed to the latest version, the default).

Body

Name Data Type Description

ObjectAccessControl


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

Responses

200Successful response

Body

Name Data Type Description

ObjectAccessControl


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

GET

/b/{bucket}/o/{object}/acl

Retrieves ACL entries on the specified object.

Request

Path

Name	Data Type	Description
`object`	string	Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`generation`	string	If present, selects a specific revision of this object (as opposed to the latest version, the default).

Responses

200Successful response

Body

Name Data Type Description

ObjectAccessControls


                        ObjectAccessControls

object

An access-control list.

Properties


                        kind

string
Default value: storage#objectAccessControls

The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls.


                        items

array [ObjectAccessControl]

The list of items.


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

POST

/b/{bucket}/o/{object}/acl

Creates a new ACL entry on the specified object.

Request

Path

Name	Data Type	Description
`object`	string	Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
`bucket`	string	Name of a bucket.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`generation`	string	If present, selects a specific revision of this object (as opposed to the latest version, the default).

Body

Name Data Type Description

ObjectAccessControl


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

Responses

200Successful response

Body

Name Data Type Description

ObjectAccessControl


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

POST

/b/{bucket}/o/watch

Watch for changes on all objects in a bucket.

Request

Path

Name	Data Type	Description
`bucket`	string	Name of the bucket in which to look for objects.

Query

Name	Data Type	Description
`versions`	boolean	If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`projection`	string Allowed values: - `full` - `noAcl`	Set of properties to return. Defaults to noAcl.
`prefix`	string	Filter results to objects whose names begin with this prefix.
`pageToken`	string	A previously-returned page token representing part of the larger set of results to view.
`maxResults`	integer Default value: `1000` Minimum: 0	Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller.
`includeTrailingDelimiter`	boolean	If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.
`delimiter`	string	Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.

Body

Name Data Type Description

Channel


                        Channel

object

An notification channel used to watch for resource changes.

Properties

`type`	string	The type of delivery mechanism used for this channel.
`token`	string	An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
`resourceUri`	string	A version-specific identifier for the watched resource.
`resourceId`	string	An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
`payload`	boolean	A Boolean value to indicate whether payload is wanted. Optional.
`params`	object	Additional parameters controlling delivery channel behavior. Optional.
`kind`	string Default value: `api#channel`	Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
`id`	string	A UUID or similar unique string that identifies this channel.
`expiration`	string	Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
`address`	string	The address where notifications are delivered for this channel.

Responses

200Successful response

Body

Name Data Type Description

Channel


                        Channel

object

An notification channel used to watch for resource changes.

Properties

`type`	string	The type of delivery mechanism used for this channel.
`token`	string	An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
`resourceUri`	string	A version-specific identifier for the watched resource.
`resourceId`	string	An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
`payload`	boolean	A Boolean value to indicate whether payload is wanted. Optional.
`params`	object	Additional parameters controlling delivery channel behavior. Optional.
`kind`	string Default value: `api#channel`	Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
`id`	string	A UUID or similar unique string that identifies this channel.
`expiration`	string	Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
`address`	string	The address where notifications are delivered for this channel.

GET

/b/{bucket}/o/{object}/iam/testPermissions

Tests a set of permissions on the given object to see which, if any, are held by the caller.

Request

Path

Name	Data Type	Description
`object`	string	Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
`bucket`	string	Name of the bucket in which the object resides.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`generation`	string	If present, selects a specific revision of this object (as opposed to the latest version, the default).
`permissions`	array	Permissions to test.

Responses

200Successful response

Body

Name Data Type Description

TestIamPermissionsResponse


                        TestIamPermissionsResponse

object

A storage.(buckets|objects).testIamPermissions response.

Properties

`permissions`	array [string]	The permissions held by the caller. Permissions are always of the format storage.resource.capability, where resource is one of buckets or objects. The supported permissions are as follows: storage.buckets.delete — Delete bucket. storage.buckets.get — Read bucket metadata. storage.buckets.getIamPolicy — Read bucket IAM policy. storage.buckets.create — Create bucket. storage.buckets.list — List buckets. storage.buckets.setIamPolicy — Update bucket IAM policy. storage.buckets.update — Update bucket metadata. storage.objects.delete — Delete object. storage.objects.get — Read object data and metadata. storage.objects.getIamPolicy — Read object IAM policy. storage.objects.create — Create object. storage.objects.list — List objects. storage.objects.setIamPolicy — Update object IAM policy. storage.objects.update — Update object metadata.
`kind`	string Default value: `storage#testIamPermissionsResponse`	The kind of item this is.

GET

/b/{bucket}/o/{object}/iam

Returns an IAM policy for the specified object.

Request

Path

Name	Data Type	Description
`object`	string	Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
`bucket`	string	Name of the bucket in which the object resides.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`generation`	string	If present, selects a specific revision of this object (as opposed to the latest version, the default).

Responses

200Successful response

Body

Name Data Type Description

Policy


                        Policy

object

A bucket/object IAM policy.

Properties

`version`	integer	The IAM policy format version.
`resourceId`	string	The ID of the resource to which this policy belongs. Will be of the form projects//buckets/bucket for buckets, and projects//buckets/bucket/objects/object for objects. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input.
`kind`	string Default value: `storage#policy`	The kind of item this is. For policies, this is always storage#policy. This field is ignored on input.
`etag`	byte	HTTP 1.1 Entity tag for the policy.
`bindings`	array [object]	An association between a role, which comes with a set of permissions, and members who may assume that role.

PUT

/b/{bucket}/o/{object}/iam

Updates an IAM policy for the specified object.

Request

Path

Name	Data Type	Description
`object`	string	Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
`bucket`	string	Name of the bucket in which the object resides.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`generation`	string	If present, selects a specific revision of this object (as opposed to the latest version, the default).

Body

Name Data Type Description

Policy


                        Policy

object

A bucket/object IAM policy.

Properties

`version`	integer	The IAM policy format version.
`resourceId`	string	The ID of the resource to which this policy belongs. Will be of the form projects//buckets/bucket for buckets, and projects//buckets/bucket/objects/object for objects. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input.
`kind`	string Default value: `storage#policy`	The kind of item this is. For policies, this is always storage#policy. This field is ignored on input.
`etag`	byte	HTTP 1.1 Entity tag for the policy.
`bindings`	array [object]	An association between a role, which comes with a set of permissions, and members who may assume that role.

Responses

200Successful response

Body

Name Data Type Description

Policy


                        Policy

object

A bucket/object IAM policy.

Properties

`version`	integer	The IAM policy format version.
`resourceId`	string	The ID of the resource to which this policy belongs. Will be of the form projects//buckets/bucket for buckets, and projects//buckets/bucket/objects/object for objects. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input.
`kind`	string Default value: `storage#policy`	The kind of item this is. For policies, this is always storage#policy. This field is ignored on input.
`etag`	byte	HTTP 1.1 Entity tag for the policy.
`bindings`	array [object]	An association between a role, which comes with a set of permissions, and members who may assume that role.

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.

Request

Path

Name	Data Type	Description
`object`	string	Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
`bucket`	string	Name of the bucket in which the object resides.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`ifMetagenerationNotMatch`	string	Makes the operation conditional on whether the object's current metageneration does not match the given value.
`ifMetagenerationMatch`	string	Makes the operation conditional on whether the object's current metageneration matches the given value.
`ifGenerationNotMatch`	string	Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
`ifGenerationMatch`	string	Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
`generation`	string	If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default).

Responses

200Successful response

GET

/b/{bucket}/o/{object}

Retrieves an object or its metadata.

Request

Path

Name	Data Type	Description
`object`	string	Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
`bucket`	string	Name of the bucket in which the object resides.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`projection`	string Allowed values: - `full` - `noAcl`	Set of properties to return. Defaults to noAcl.
`ifMetagenerationNotMatch`	string	Makes the operation conditional on whether the object's current metageneration does not match the given value.
`ifMetagenerationMatch`	string	Makes the operation conditional on whether the object's current metageneration matches the given value.
`ifGenerationNotMatch`	string	Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
`ifGenerationMatch`	string	Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
`generation`	string	If present, selects a specific revision of this object (as opposed to the latest version, the default).

Responses

200Successful response

Body

Name Data Type Description

Object


                        Object

object

An object.

Properties


                        updated

dateTime

The modification time of the object metadata in RFC 3339 format.


                        timeStorageClassUpdated

dateTime

The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.


                        timeDeleted

dateTime

The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.


                        timeCreated

dateTime

The creation time of the object in RFC 3339 format.


                        temporaryHold

boolean

Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object.


                        storageClass

string

Storage class of the object.


                        size

string

Content-Length of the data in bytes.


                        selfLink

string

The link to this object.


                        retentionExpirationTime

dateTime

A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).

owner


                        name

string

The name of the object. Required if not specified by URL parameter.


                        metageneration

string

The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.


                        metadata

object

User-provided metadata, in key/value pairs.


                        mediaLink

string

Media download link.


                        md5Hash

string

MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.


                        kmsKeyName

string

Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.


                        kind

string
Default value: storage#object

The kind of item this is. For objects, this is always storage#object.

id

string

The ID of the object, including the bucket name, object name, and generation number.


                        generation

string

The content generation of this object. Used for object versioning.


                        eventBasedHold

boolean

Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.


                        etag

string

HTTP 1.1 Entity tag for the object.

customerEncryption


                        crc32c

string

CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.


                        contentType

string

Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.


                        contentLanguage

string

Content-Language of the object data.


                        contentEncoding

string

Content-Encoding of the object data.


                        contentDisposition

string

Content-Disposition of the object data.


                        componentCount

integer

Number of underlying components that make up this object. Components are accumulated by compose operations.


                        cacheControl

string

Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.


                        bucket

string

The name of the bucket containing this object.

acl

array [ObjectAccessControl]

Access controls on the object.


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

PATCH

/b/{bucket}/o/{object}

Patches an object's metadata.

Request

Path

Name	Data Type	Description
`object`	string	Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
`bucket`	string	Name of the bucket in which the object resides.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request, for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`projection`	string Allowed values: - `full` - `noAcl`	Set of properties to return. Defaults to full.
`predefinedAcl`	string Allowed values: - `authenticatedRead` - `bucketOwnerFullControl` - `bucketOwnerRead` - `private` - `projectPrivate` - `publicRead`	Apply a predefined set of access controls to this object.
`ifMetagenerationNotMatch`	string	Makes the operation conditional on whether the object's current metageneration does not match the given value.
`ifMetagenerationMatch`	string	Makes the operation conditional on whether the object's current metageneration matches the given value.
`ifGenerationNotMatch`	string	Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
`ifGenerationMatch`	string	Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
`generation`	string	If present, selects a specific revision of this object (as opposed to the latest version, the default).

Body

Name Data Type Description

Object


                        Object

object

An object.

Properties


                        updated

dateTime

The modification time of the object metadata in RFC 3339 format.


                        timeStorageClassUpdated

dateTime

The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.


                        timeDeleted

dateTime

The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.


                        timeCreated

dateTime

The creation time of the object in RFC 3339 format.


                        temporaryHold

boolean

Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object.


                        storageClass

string

Storage class of the object.


                        size

string

Content-Length of the data in bytes.


                        selfLink

string

The link to this object.


                        retentionExpirationTime

dateTime

A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).

owner


                        name

string

The name of the object. Required if not specified by URL parameter.


                        metageneration

string

The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.


                        metadata

object

User-provided metadata, in key/value pairs.


                        mediaLink

string

Media download link.


                        md5Hash

string

MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.


                        kmsKeyName

string

Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.


                        kind

string
Default value: storage#object

The kind of item this is. For objects, this is always storage#object.

id

string

The ID of the object, including the bucket name, object name, and generation number.


                        generation

string

The content generation of this object. Used for object versioning.


                        eventBasedHold

boolean

Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.


                        etag

string

HTTP 1.1 Entity tag for the object.

customerEncryption


                        crc32c

string

CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.


                        contentType

string

Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.


                        contentLanguage

string

Content-Language of the object data.


                        contentEncoding

string

Content-Encoding of the object data.


                        contentDisposition

string

Content-Disposition of the object data.


                        componentCount

integer

Number of underlying components that make up this object. Components are accumulated by compose operations.


                        cacheControl

string

Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.


                        bucket

string

The name of the bucket containing this object.

acl

array [ObjectAccessControl]

Access controls on the object.


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

Responses

200Successful response

Body

Name Data Type Description

Object


                        Object

object

An object.

Properties


                        updated

dateTime

The modification time of the object metadata in RFC 3339 format.


                        timeStorageClassUpdated

dateTime

The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.


                        timeDeleted

dateTime

The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.


                        timeCreated

dateTime

The creation time of the object in RFC 3339 format.


                        temporaryHold

boolean

Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object.


                        storageClass

string

Storage class of the object.


                        size

string

Content-Length of the data in bytes.


                        selfLink

string

The link to this object.


                        retentionExpirationTime

dateTime

A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).

owner


                        name

string

The name of the object. Required if not specified by URL parameter.


                        metageneration

string

The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.


                        metadata

object

User-provided metadata, in key/value pairs.


                        mediaLink

string

Media download link.


                        md5Hash

string

MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.


                        kmsKeyName

string

Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.


                        kind

string
Default value: storage#object

The kind of item this is. For objects, this is always storage#object.

id

string

The ID of the object, including the bucket name, object name, and generation number.


                        generation

string

The content generation of this object. Used for object versioning.


                        eventBasedHold

boolean

Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.


                        etag

string

HTTP 1.1 Entity tag for the object.

customerEncryption


                        crc32c

string

CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.


                        contentType

string

Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.


                        contentLanguage

string

Content-Language of the object data.


                        contentEncoding

string

Content-Encoding of the object data.


                        contentDisposition

string

Content-Disposition of the object data.


                        componentCount

integer

Number of underlying components that make up this object. Components are accumulated by compose operations.


                        cacheControl

string

Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.


                        bucket

string

The name of the bucket containing this object.

acl

array [ObjectAccessControl]

Access controls on the object.


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

PUT

/b/{bucket}/o/{object}

Updates an object's metadata.

Request

Path

Name	Data Type	Description
`object`	string	Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
`bucket`	string	Name of the bucket in which the object resides.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`projection`	string Allowed values: - `full` - `noAcl`	Set of properties to return. Defaults to full.
`predefinedAcl`	string Allowed values: - `authenticatedRead` - `bucketOwnerFullControl` - `bucketOwnerRead` - `private` - `projectPrivate` - `publicRead`	Apply a predefined set of access controls to this object.
`ifMetagenerationNotMatch`	string	Makes the operation conditional on whether the object's current metageneration does not match the given value.
`ifMetagenerationMatch`	string	Makes the operation conditional on whether the object's current metageneration matches the given value.
`ifGenerationNotMatch`	string	Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
`ifGenerationMatch`	string	Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
`generation`	string	If present, selects a specific revision of this object (as opposed to the latest version, the default).

Body

Name Data Type Description

Object


                        Object

object

An object.

Properties


                        updated

dateTime

The modification time of the object metadata in RFC 3339 format.


                        timeStorageClassUpdated

dateTime

The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.


                        timeDeleted

dateTime

The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.


                        timeCreated

dateTime

The creation time of the object in RFC 3339 format.


                        temporaryHold

boolean

Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object.


                        storageClass

string

Storage class of the object.


                        size

string

Content-Length of the data in bytes.


                        selfLink

string

The link to this object.


                        retentionExpirationTime

dateTime

A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).

owner


                        name

string

The name of the object. Required if not specified by URL parameter.


                        metageneration

string

The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.


                        metadata

object

User-provided metadata, in key/value pairs.


                        mediaLink

string

Media download link.


                        md5Hash

string

MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.


                        kmsKeyName

string

Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.


                        kind

string
Default value: storage#object

The kind of item this is. For objects, this is always storage#object.

id

string

The ID of the object, including the bucket name, object name, and generation number.


                        generation

string

The content generation of this object. Used for object versioning.


                        eventBasedHold

boolean

Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.


                        etag

string

HTTP 1.1 Entity tag for the object.

customerEncryption


                        crc32c

string

CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.


                        contentType

string

Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.


                        contentLanguage

string

Content-Language of the object data.


                        contentEncoding

string

Content-Encoding of the object data.


                        contentDisposition

string

Content-Disposition of the object data.


                        componentCount

integer

Number of underlying components that make up this object. Components are accumulated by compose operations.


                        cacheControl

string

Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.


                        bucket

string

The name of the bucket containing this object.

acl

array [ObjectAccessControl]

Access controls on the object.


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

Responses

200Successful response

Body

Name Data Type Description

Object


                        Object

object

An object.

Properties


                        updated

dateTime

The modification time of the object metadata in RFC 3339 format.


                        timeStorageClassUpdated

dateTime

The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.


                        timeDeleted

dateTime

The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.


                        timeCreated

dateTime

The creation time of the object in RFC 3339 format.


                        temporaryHold

boolean

Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object.


                        storageClass

string

Storage class of the object.


                        size

string

Content-Length of the data in bytes.


                        selfLink

string

The link to this object.


                        retentionExpirationTime

dateTime

A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).

owner


                        name

string

The name of the object. Required if not specified by URL parameter.


                        metageneration

string

The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.


                        metadata

object

User-provided metadata, in key/value pairs.


                        mediaLink

string

Media download link.


                        md5Hash

string

MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.


                        kmsKeyName

string

Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.


                        kind

string
Default value: storage#object

The kind of item this is. For objects, this is always storage#object.

id

string

The ID of the object, including the bucket name, object name, and generation number.


                        generation

string

The content generation of this object. Used for object versioning.


                        eventBasedHold

boolean

Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.


                        etag

string

HTTP 1.1 Entity tag for the object.

customerEncryption


                        crc32c

string

CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.


                        contentType

string

Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.


                        contentLanguage

string

Content-Language of the object data.


                        contentEncoding

string

Content-Encoding of the object data.


                        contentDisposition

string

Content-Disposition of the object data.


                        componentCount

integer

Number of underlying components that make up this object. Components are accumulated by compose operations.


                        cacheControl

string

Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.


                        bucket

string

The name of the bucket containing this object.

acl

array [ObjectAccessControl]

Access controls on the object.


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

GET

/b/{bucket}/o

Retrieves a list of objects matching the criteria.

Request

Path

Name	Data Type	Description
`bucket`	string	Name of the bucket in which to look for objects.

Query

Name	Data Type	Description
`versions`	boolean	If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`projection`	string Allowed values: - `full` - `noAcl`	Set of properties to return. Defaults to noAcl.
`prefix`	string	Filter results to objects whose names begin with this prefix.
`pageToken`	string	A previously-returned page token representing part of the larger set of results to view.
`maxResults`	integer Default value: `1000` Minimum: 0	Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller.
`includeTrailingDelimiter`	boolean	If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.
`delimiter`	string	Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.

Responses

200Successful response

Body

Name Data Type Description

Objects


                        Objects

object

A list of objects.

Properties


                        prefixes

array [string]

The list of prefixes of objects matching-but-not-listed up to and including the requested delimiter.


                        nextPageToken

string

The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.


                        kind

string
Default value: storage#objects

The kind of item this is. For lists of objects, this is always storage#objects.


                        items

array [Object]

The list of items.


                        Object

object

An object.

Properties

`updated`	dateTime	The modification time of the object metadata in RFC 3339 format.
`timeStorageClassUpdated`	dateTime	The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.
`timeDeleted`	dateTime	The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
`timeCreated`	dateTime	The creation time of the object in RFC 3339 format.
`temporaryHold`	boolean	Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object.
`storageClass`	string	Storage class of the object.
`size`	string	Content-Length of the data in bytes.
`selfLink`	string	The link to this object.
`retentionExpirationTime`	dateTime	A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).
`owner`
`name`	string	The name of the object. Required if not specified by URL parameter.
`metageneration`	string	The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.
`metadata`	object	User-provided metadata, in key/value pairs.
`mediaLink`	string	Media download link.
`md5Hash`	string	MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
`kmsKeyName`	string	Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
`kind`	string Default value: `storage#object`	The kind of item this is. For objects, this is always storage#object.
`id`	string	The ID of the object, including the bucket name, object name, and generation number.
`generation`	string	The content generation of this object. Used for object versioning.
`eventBasedHold`	boolean	Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.
`etag`	string	HTTP 1.1 Entity tag for the object.
`customerEncryption`
`crc32c`	string	CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
`contentType`	string	Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.
`contentLanguage`	string	Content-Language of the object data.
`contentEncoding`	string	Content-Encoding of the object data.
`contentDisposition`	string	Content-Disposition of the object data.
`componentCount`	integer	Number of underlying components that make up this object. Components are accumulated by compose operations.
`cacheControl`	string	Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
`bucket`	string	The name of the bucket containing this object.
`acl`	array [ObjectAccessControl]	Access controls on the object.

POST

/b/{bucket}/o

Stores a new object and metadata.

Request

Path

Name	Data Type	Description
`bucket`	string	Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.

Query

Name	Data Type	Description
`userProject`	string	The project to be billed for this request. Required for Requester Pays buckets.
`provisionalUserProject`	string	The project to be billed for this request if the target bucket is requester-pays bucket.
`projection`	string Allowed values: - `full` - `noAcl`	Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.
`predefinedAcl`	string Allowed values: - `authenticatedRead` - `bucketOwnerFullControl` - `bucketOwnerRead` - `private` - `projectPrivate` - `publicRead`	Apply a predefined set of access controls to this object.
`name`	string	Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
`kmsKeyName`	string	Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
`ifMetagenerationNotMatch`	string	Makes the operation conditional on whether the object's current metageneration does not match the given value.
`ifMetagenerationMatch`	string	Makes the operation conditional on whether the object's current metageneration matches the given value.
`ifGenerationNotMatch`	string	Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
`ifGenerationMatch`	string	Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
`contentEncoding`	string	If set, sets the contentEncoding property of the final object to this value. Setting this parameter is equivalent to setting the contentEncoding metadata property. This can be useful when uploading an object with uploadType=media to indicate the encoding of the content being uploaded.

Body

Name Data Type Description

Object


                        Object

object

An object.

Properties


                        updated

dateTime

The modification time of the object metadata in RFC 3339 format.


                        timeStorageClassUpdated

dateTime

The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.


                        timeDeleted

dateTime

The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.


                        timeCreated

dateTime

The creation time of the object in RFC 3339 format.


                        temporaryHold

boolean

Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object.


                        storageClass

string

Storage class of the object.


                        size

string

Content-Length of the data in bytes.


                        selfLink

string

The link to this object.


                        retentionExpirationTime

dateTime

A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).

owner


                        name

string

The name of the object. Required if not specified by URL parameter.


                        metageneration

string

The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.


                        metadata

object

User-provided metadata, in key/value pairs.


                        mediaLink

string

Media download link.


                        md5Hash

string

MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.


                        kmsKeyName

string

Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.


                        kind

string
Default value: storage#object

The kind of item this is. For objects, this is always storage#object.

id

string

The ID of the object, including the bucket name, object name, and generation number.


                        generation

string

The content generation of this object. Used for object versioning.


                        eventBasedHold

boolean

Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.


                        etag

string

HTTP 1.1 Entity tag for the object.

customerEncryption


                        crc32c

string

CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.


                        contentType

string

Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.


                        contentLanguage

string

Content-Language of the object data.


                        contentEncoding

string

Content-Encoding of the object data.


                        contentDisposition

string

Content-Disposition of the object data.


                        componentCount

integer

Number of underlying components that make up this object. Components are accumulated by compose operations.


                        cacheControl

string

Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.


                        bucket

string

The name of the bucket containing this object.

acl

array [ObjectAccessControl]

Access controls on the object.


                        ObjectAccessControl

object

An access-control entry.

Properties

`selfLink`	string	The link to this access-control entry.
`role`	string	The access permission for the entity.
`projectTeam`
`object`	string	The name of the object, if applied to an object.
`kind`	string Default value: `storage#objectAccessControl`	The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
`id`	string	The ID of the access-control entry.
`generation`	string	The content generation of the object, if applied to an object.
`etag`	string	HTTP 1.1 Entity tag for the access-control entry.
`entityId`	string	The ID for the entity, if any.
`entity`	string	The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
`email`	string	The email address associated with the entity, if any.
`domain`	string	The domain associated with the entity, if any.
`bucket`	string	The name of the bucket.

Responses

200Successful response

Body

Name Data Type Description

Object


                        Object

object

An object.

Properties

`updated`	dateTime	The modification time of the object metadata in RFC 3339 format.
`timeStorageClassUpdated`	dateTime	The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.
`timeDeleted`	dateTime	The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
`timeCreated`	dateTime	The creation time of the object in RFC 3339 format.
`temporaryHold`	boolean	Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object.
`storageClass`	string	Storage class of the object.
`size`	string	Content-Length of the data in bytes.
`selfLink`	string	The link to this object.
`retentionExpirationTime`	dateTime	A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).
`owner`
`name`	string	The name of the object. Required if not specified by URL parameter.
`metageneration`	string	The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.
`metadata`	object	User-provided metadata, in key/value pairs.
`mediaLink`	string	Media download link.
`md5Hash`	string	MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
`kmsKeyName`	string	Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
`kind`	string Default value: `storage#object`	The kind of item this is. For objects, this is always storage#object.
`id`	string	The ID of the object, including the bucket name, object name, and generation number.
`generation`	string	The content generation of this object. Used for object versioning.
`eventBasedHold`	boolean	Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.
`etag`	string	HTTP 1.1 Entity tag for the object.
`customerEncryption`
`crc32c`	string	CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
`contentType`	string	Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.
`contentLanguage`	string	Content-Language of the object data.
`contentEncoding`	string	Content-Encoding of the object data.
`contentDisposition`	string	Content-Disposition of the object data. <

Cloud Storage

Resources

bucketAccessControls

Request

Path

Query

Responses

Request

Path

Query

Responses

Body

Properties

Request

Path

Query

Body

Properties

Responses

Body

Properties

Request

Path

Query

Body

Properties

Responses

Body

Properties

Request

Path

Query

Responses

Body

Properties

Properties

Request

Path

Query

Body

Properties

Responses

Body

Properties

buckets

Request

Path

Query

Responses

Body

Properties

Request

Path

Query

Responses

Body

Properties

Request

Path

Query

Body

Properties

Responses

Body

Properties

Request

Path

Query

Responses

Body

Properties

Properties

Properties

Request

Path

Query

Responses

Request

Path

Query