> ## Documentation Index > Fetch the complete documentation index at: https://docs.basaltic.sh/llms.txt > Use this file to discover all available pages before exploring further. # Create bucket > Provision a new bucket. The name must be unique within the region (S3 rule); 3-63 lowercase characters, digits, and hyphens; no leading/trailing hyphen. ## OpenAPI ````yaml /api-reference/specs/storage.yaml post /v1/buckets openapi: 3.0.3 info: title: Basaltic Storage API version: 1.0.0 description: | Block volumes with their snapshots and snapshot policies, plus bucket management for object storage. The S3 wire protocol itself is served separately at `objects.{region}.basaltic.cloud`. contact: name: Basaltic Support email: ping@basaltic.sh license: name: Proprietary url: https://basaltic.sh/terms servers: - url: https://storage.{region}.basaltic.sh description: Regional API endpoint variables: region: default: sa-saopaulo-1 description: Region code security: - SignatureAuth: [] paths: /v1/buckets: post: tags: - Buckets summary: Create bucket description: | Provision a new bucket. The name must be unique within the region (S3 rule); 3-63 lowercase characters, digits, and hyphens; no leading/trailing hyphen. operationId: createBucket parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateBucketRequest' responses: '201': description: Bucket created. content: application/json: schema: $ref: '#/components/schemas/BucketResponse' '400': description: Invalid request body or bucket name. '401': $ref: '#/components/responses/Unauthorized' '403': description: Caller lacks the required IAM permission. '409': description: >- Bucket name already taken, or the account's bucket quota is exhausted. '422': $ref: '#/components/responses/UnprocessableEntity' security: - SignatureAuth: [] components: parameters: IdempotencyKey: name: Idempotency-Key in: header description: >- Optional client-generated key that makes a create replay-safe. Retrying a request with the same key returns the original outcome verbatim instead of creating a duplicate resource. Reusing a key with a different request body is rejected (422); a request whose key is still being processed returns 409. Records are honored for 24 hours. Use a UUID or similarly unique token. required: false schema: type: string maxLength: 255 example: 550e8400-e29b-41d4-a716-446655440000 schemas: CreateBucketRequest: type: object required: - name properties: name: type: string minLength: 3 maxLength: 63 pattern: ^[a-z0-9][a-z0-9\-]{1,61}[a-z0-9]$ example: my-app-assets object_lock_enabled: type: boolean description: | When true, enables S3 Object Lock on the bucket at creation time and turns versioning on. Object Lock cannot be enabled later. example: false BucketResponse: type: object properties: bucket: $ref: '#/components/schemas/Bucket' Bucket: type: object required: - id - name - crn - acl - versioning - deletion_protection - deletion_recovery_days - created_at properties: id: type: string format: uuid readOnly: true example: c4e2a1f8-6b3d-4e9a-8c7f-2d1e0a3b4c5d name: type: string example: my-app-assets crn: type: string example: crn:storage:sa-saopaulo-1:platform:bucket/my-app-assets readOnly: true acl: type: string example: private versioning: type: string description: >- Versioning state. `suspended` means versioning was on and was turned off — existing versions are kept, new writes stop creating them — which is distinct from `disabled`, a bucket that never had it enabled. The S3-compatible endpoint spells the same states `Enabled` / `Suspended` in its XML, and reports `disabled` by omitting the element. enum: - disabled - enabled - suspended example: disabled deletion_protection: type: boolean description: >- When true, DeleteBucket schedules deletion instead of removing the bucket immediately. example: false deletion_recovery_days: type: integer description: >- Recovery window, in days, applied when a deletion is scheduled. 0 means the service default is used. example: 7 scheduled_deletion_at: type: string format: date-time readOnly: true description: >- Deadline a protected bucket is deleted at. Present only while a deletion is pending — POST /v1/buckets/{bucket}/restore before it passes to cancel. example: '2026-01-22T09:30:00Z' created_at: type: string format: date-time readOnly: true example: '2026-01-15T09:30:00Z' Error: type: object required: - error properties: error: type: object required: - code - message - request_id properties: code: type: string description: Error code identifying the type of error example: INVALID_INPUT message: type: string description: Human-readable error message example: Invalid request parameters request_id: type: string format: uuid description: Request ID for debugging example: 550e8400-e29b-41d4-a716-446655440000 responses: Unauthorized: description: Authentication required or token invalid content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: UNAUTHORIZED message: Authentication required request_id: 550e8400-e29b-41d4-a716-446655440000 UnprocessableEntity: description: | The request is well-formed but cannot be processed as sent. On the operations that accept `Idempotency-Key` this is the key-reuse case: the key was first seen with a different request payload, so replaying the stored outcome would answer a question the caller did not ask. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: IDEMPOTENCY_KEY_REUSED message: >- This Idempotency-Key was already used with a different request payload request_id: 550e8400-e29b-41d4-a716-446655440000 securitySchemes: SignatureAuth: type: apiKey in: header name: Authorization description: > Request signing with an access key issued to a service account. An HMAC-SHA256 over a canonical form of the request, close to AWS SigV4. The `basaltic` CLI signs for you. Send `Authorization`, `X-Date` (UTC, `YYYYMMDDTHHMMSSZ`) and `X-Nonce` (random per request); add `X-Content-Sha256` to bind a body, and `X-Amz-Security-Token` when using temporary credentials. ``` Authorization: BASALTIC-HMAC-SHA256 Credential=///basaltic/basaltic_request, SignedHeaders=host;x-date;x-nonce, Signature= ``` `` is the region code you are calling, or `global` for the global services. A signature is valid for 5 minutes from `X-Date`, and mutating requests are replay-guarded on the nonce. **Full signing procedure, including a working implementation:** https://docs.basaltic.sh/authentication ## Rate limits There is no global request budget. A limit applies only where an operation documents a `429`, and that operation says what it counts. Those responses carry `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` and, on a `429`, `Retry-After` — read them rather than hard-coding a number. Retrying before `Retry-After` is refused and extends the window. Everything else is bounded by quota, not by request rate. ````