Bucket:Create Bucket

Search (SHIFT+S)

New in this release

Create Bucket

POST /object/bucket

Creates a bucket in which users can create objects. The bucket is created in a storage pool associated with the specified replication group.

  • Current user will become the bucket owner.

  • If namespace to this bucket creation does not exist, user's namespace is used

  • For non SYSTEM_ADMIN user, namespace should be current user's namespace

Required Roles

Requires one of the following roles:




The following conditions must be met in order to call this operation.

  • A qualifying storage pool must exist corresponding to the replication group for bucket

  • Only authenticated users can create buckets

  • Bucket name should be less than 255 characters

  • Bucket name should contain only alphanumeric, '.','-' and '_'.

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<name> Bucket name String
<vpool> Replication group identifier URI
<filesystem_enabled> flag indicating whether file-system is enabled for this bucket Boolean
<head_type> HeadType indicates the object head type that is allowed to access the bucket. If the bucket has FS-Enabled, then the FS heads are implicitly allowed to access this bucket String
<namespace> Namespace associated with the user/tenant that is allowed to access the bucket String
<is_stale_allowed> tag to allow stale data in bucket Boolean

Response Body

Indicating success or failure of the bucket create operation

Field Description Type Notes
<error_message> Message returned by the server indicating the reason for create bucket failure (if any) String
<name> Name assigned to this resource in ECS. The resource name is set by a user and can be changed at any time. It is not a unique identifier. String
<id> Identifier that is generated by ECS when the resource is created. The resource Id is guaranteed to be unique and immutable across all virtual data centers for all time. URI Valid Values:
  •  urn:storageos:resource-type:UUID:
<link> Hyperlink to the details for this resource
<creation_time> Timestamp that shows when this resource was created in ECS DateTime Valid Values:
  •  YYYY-MM-DDTHH:mm:ssZ
<tags> Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search.
<tag> String 0-* Elements
<inactive> Indicates whether the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ECS database. Boolean Valid Values:
  •  true
  •  false
<global> Indicates whether the resource is global. Boolean Valid Values:
  •  true
  •  false
<remote> Indicates whether the resource is remote. Boolean Valid Values:
  •  true
  •  false
<id> ECS Id of the related object URI
<link> Hyperlink to the related object
<internal> Indicated whether the resource is an internal resource Boolean Valid Values:
  •  true
  •  false



Content-Type: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>