Buckets: insert
Creates a new bucket.
You can't create a bucket with a name that is already in use by another live bucket, because Cloud Storage uses a single, global namespace for bucket names. For more information, see thebucket naming guidelines.
Required permissions
To use this method,the authenticated user must have thestorage.buckets.create IAM permission. Additionally, to enable specific bucket features, the authenticated user must have the following permissions:
- To enable object retention using the
enableObjectRetentionquery parameter:storage.buckets.enableObjectRetention - To set the bucket IP filtering rules:
storage.buckets.setIpFilter
Request
HTTP request
POST https://storage.googleapis.com/storage/v1/b
In addition tostandard query parameters, the following query parameters apply to this method.
To see an example of how to include query parameters in a request, see theJSON API Overview page.
Parameters
| Parameter name | Value | Description |
|---|---|---|
| Required query parameters | ||
project | string | A valid API project identifier. |
| Optional query parameters | ||
enableObjectRetention | boolean | When set totrue, permanently enable object retention for this bucket. |
predefinedAcl | string | Apply a predefined set of access controls to this bucket. Acceptable values are:
iamConfiguration.uniformBucketLevelAccess.enabled is set totrue, requests that include this parameter fail with a400 Bad Request response. |
predefinedDefaultObjectAcl | string | Apply a predefined set of default object access controls to this bucket. Acceptable values are:
iamConfiguration.uniformBucketLevelAccess.enabled is set totrue, requests that include this parameter fail with a400 Bad Request response. |
projection | string | Set of properties to return. Defaults tonoAcl, unless the bucket resource specifiesacl ordefaultObjectAcl properties, when it defaults tofull.Acceptable values are:
|
Request body
In the request body, supply abucket resource with the following properties:
| Property name | Value | Description | Notes |
|---|---|---|---|
| Required Properties | |||
name | string | The name of the bucket. See the bucket naming guidelines for more information. | |
| Optional Properties | |||
acl[] | list | Access controls on the bucket, containing one or morebucketAccessControls Resources. IfiamConfiguration.uniformBucketLevelAccess.enabled is set totrue, this field is omitted in responses, and requests that specify this field fail with a400 Bad Request response. | writable |
autoclass | object | Thebucket's Autoclass configuration, which, when enabled, controls the storage class of objects based on how and when the objects are accessed. For more information, seeAutoclass. | writable |
billing | object | Thebucket's billing configuration, used to control theRequester Pays feature. | writable |
cors[] | list | Thebucket's CORS configuration. For more information, seeCross-Origin Resource Sharing. | writable |
customPlacementConfig | object | Applicable only if a bucket is located in aconfigurable dual-region. Thebucket's custom location configuration. | writable |
defaultEventBasedHold | boolean | Whether or not to automatically apply aneventBasedHold to new objects added to the bucket. | writable |
defaultObjectAcl[] | list | Default access controls to apply to new objects when no ACL is provided. This list defines anentity androle for one or moredefaultObjectAccessControls Resources. IfiamConfiguration.uniformBucketLevelAccess.enabled is set totrue, this field is omitted in responses, and requests that specify this field fail with a400 Bad Request response. | writable |
encryption | object | Thebucket's encryption configuration. | writable |
hierarchicalNamespace.enabled | boolean | Whether or not hierarchical namespace is enabled for this bucket. | writeable |
iamConfiguration | object | Thebucket's IAM configuration. | writable |
ipFilter | object | Thebucket IP filtering configuration. For more information about bucket IP filtering, seeBucket IP filtering. | writable |
labels | object | User-providedbucket labels, in key/value pairs. | writable |
labels.(key) | string | An individual label entry. | writable |
lifecycle | object | The bucket'slifecycle configuration. Seelifecycle management for more information. | writable |
location | string | The location of the bucket. Object data for objects in the bucket resides in physical storage within this location. Defaults to"US". SeeCloud Storage bucket locations for the authoritative list. | writable |
logging | object | Thebucket's logging configuration. For more information, seeusage logs and storage logs. | writable |
retentionPolicy | object | Thebucket's retention policy configuration. For more information, seeBucket Lock. | writable |
rpo | string | The recovery point objective for cross-region replication of the bucket. Applicable only for dual- and multi-region buckets."DEFAULT" uses default replication."ASYNC_TURBO" enables turbo replication, valid for dual-region buckets only. Ifrpo is not specified when the bucket is created, it defaults to"DEFAULT". For more information, seeredundancy across regions. | writable |
softDeletePolicy | object | Thebucket's soft delete policy configuration. For more information, seeSoft Delete. | writeable |
storageClass | string | The bucket's default storage class, used whenever nostorageClass is specified for a newly-created object. IfstorageClass is not specified when the bucket is created, it defaults to"STANDARD". For available storage classes, seeStorage classes. | writable |
versioning | object | Thebucket's versioning configuration. For more information, seeObject Versioning. | writable |
website | object | Thebucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See theStatic Website Examples for more information. | writable |
Response
If successful, this method returns abucket resource in the response body.
For information about status and error codes returned by this API, see thereference page.
Try it!
Use the APIs Explorer below to call this method on live data and see the response.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-17 UTC.