Console
    Contact Us Start free

    Buckets: insert

    Requires authorization

    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 the bucket naming guidelines .

    Required permissions

    To use this method,the authenticated user must have the storage.buckets.create IAM permission. Additionally, to enable specific bucket features, the authenticated user must have the following permissions:

    • To enable object retention using the enableObjectRetention query 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 to standard query parameters , the following query parameters apply to this method.

    To see an example of how to include query parameters in a request, see the JSON 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 to true , permanently enable object retention for this bucket.
    predefinedAcl
    string
    Apply a predefined set of access controls to this bucket.

    Acceptable values are:
    • authenticatedRead : Project team owners get OWNER access, and allAuthenticatedUsers get READER access.
    • private : Project team owners get OWNER access.
    • projectPrivate : Project team members get access according to their roles.
    • publicRead : Project team owners get OWNER access, and allUsers get READER access.
    • publicReadWrite : Project team owners get OWNER access, and allUsers get WRITER access.
    If iamConfiguration.uniformBucketLevelAccess.enabled is set to true , requests that include this parameter fail with a 400 Bad Request response.
    predefinedDefaultObjectAcl
    string
    Apply a predefined set of default object access controls to this bucket.

    Acceptable values are:
    • authenticatedRead : Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
    • bucketOwnerFullControl : Object owner gets OWNER access, and project team owners get OWNER access.
    • bucketOwnerRead : Object owner gets OWNER access, and project team owners get READER access.
    • private : Object owner gets OWNER access.
    • projectPrivate : Object owner gets OWNER access, and project team members get access according to their roles.
    • publicRead : Object owner gets OWNER access, and allUsers get READER access.
    If iamConfiguration.uniformBucketLevelAccess.enabled is set to true , requests that include this parameter fail with a 400 Bad Request response.
    projection
    string
    Set of properties to return. Defaults to noAcl , unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full .

    Acceptable values are:
    • full : Include all properties.
    • noAcl : Omit owner , acl , and defaultObjectAcl properties.

    Request body

    In the request body, supply a bucket 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 more bucketAccessControls Resources . If iamConfiguration.uniformBucketLevelAccess.enabled is set to true , this field is omitted in responses, and requests that specify this field fail with a 400 Bad Request response.
    writable
    autoclass
    object
    The bucket's Autoclass configuration , which, when enabled, controls the storage class of objects based on how and when the objects are accessed. For more information, see Autoclass .
    writable
    billing
    object
    The bucket's billing configuration , used to control the Requester Pays feature.
    writable
    cors[]
    list
    The bucket's CORS configuration . For more information, see Cross-Origin Resource Sharing .
    writable
    customPlacementConfig
    object
    Applicable only if a bucket is located in a configurable dual-region . The bucket's custom location configuration .
    writable
    defaultEventBasedHold
    boolean
    Whether or not to automatically apply an eventBasedHold 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 an entity and role for one or more defaultObjectAccessControls Resources . If iamConfiguration.uniformBucketLevelAccess.enabled is set to true , this field is omitted in responses, and requests that specify this field fail with a 400 Bad Request response.
    writable
    encryption
    object
    The bucket's encryption configuration .
    writable
    hierarchicalNamespace.enabled
    boolean
    Whether or not hierarchical namespace is enabled for this bucket.
    writeable
    iamConfiguration
    object
    The bucket's IAM configuration .
    writable
    ipFilter
    object
    The bucket IP filtering configuration . For more information about bucket IP filtering, see Bucket IP filtering .
    writable
    labels
    object
    User-provided bucket labels , in key/value pairs.
    writable
    labels.(key)
    string
    An individual label entry.
    writable
    lifecycle
    object
    The bucket's lifecycle configuration . See lifecycle 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" . See Cloud Storage bucket locations for the authoritative list.
    writable
    logging
    object
    The bucket's logging configuration . For more information, see usage logs and storage logs .
    writable
    retentionPolicy
    object
    The bucket's retention policy configuration . For more information, see Bucket 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. If rpo is not specified when the bucket is created, it defaults to "DEFAULT" . For more information, see redundancy across regions .
    writable
    softDeletePolicy
    object
    The bucket's soft delete policy configuration . For more information, see Soft Delete .
    writeable
    storageClass
    string
    The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. If storageClass is not specified when the bucket is created, it defaults to "STANDARD" . For available storage classes, see Storage classes .
    writable
    versioning
    object
    The bucket's versioning configuration . For more information, see Object Versioning .
    writable
    website
    object
    The bucket's website configuration , controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.
    writable

    Response

    If successful, this method returns a bucket resource in the response body.

    For information about status and error codes returned by this API, see the reference page .

    Try it!

    Use the APIs Explorer below to call this method on live data and see the response.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: