Create Bucket

Create a new bucket for your account.
EndpointMethodAdmin Required
/api/v1/bucketsPOSTNo

Creates a new bucket owned by the authenticated user.

Request Body

name
string required
Bucket name. Must follow S3 naming conventions:
  • 3-63 characters long
  • Lowercase letters, numbers, and hyphens only
  • Must start with a letter or number
  • Cannot end with a hyphen
versioningEnabled
boolean required
Whether to enable versioning for this bucket.

Example

{
    "name": "my-new-bucket",
    "versioningEnabled": true
}

Response

Returns the created bucket:

{
    "id": "D3E4F5G6-H7I8-9012-JKLM-NO3456789012",
    "name": "my-new-bucket",
    "versioningStatus": "Enabled"
}

Errors

StatusReason
400Invalid bucket name
409Bucket name already exists

List Buckets

Retrieve your own buckets with pagination.

Delete Bucket

Delete one of your buckets and all its contents.