s3.buckets.create

Create a bucket

POST /s3/api/bucketsIAM s3:CreateBucketChanges state

Bucket names are shared by everyone on the platform: 409 when the name is taken or the organization is at its bucket limit.

Request syntax

POST /s3/api/buckets
{
  "name": "string",
  "objectLock": "boolean",
  "zone": "string",
  "kmsKeyId": "string",
  "tags": "map of string"
}

Request body

  • nameRequired

    string

    Globally unique: 3–63 lowercase letters, digits and hyphens, no dots

    Constraints: 3-63 chars, /^[a-z0-9][a-z0-9-]*[a-z0-9]$/

  • objectLockOptional

    boolean

    Enable object lock, and with it versioning, for good. Only possible at creation

  • zoneOptional

    string

    Zone the bytes live in, e.g. de1a (Falkenstein) or de1b (Nuremberg); the region default when omitted. Fixed for good

    Constraints: max 16 chars

  • kmsKeyIdOptional

    string

    KMS key that encrypts the objects (SSE-KMS); the platform key (SSE-S3) when omitted. Needs kms:Encrypt on it

  • tagsOptional

    map of string

    Tags for the new resource, e.g. {"env": "prod", "project": "shop"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).

    Constraints: key=value

Response

201; data is the new bucket: id, name, zone, region, objectLock, encryption, pathStyleUrl, virtualHostedUrl and createdAt.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow s3:CreateBucket on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud s3 buckets create --name example

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_s3_buckets_create.