Buckets

Create a bucket

Provisions a Khotan-managed storage bucket synchronously and responds 201 with the persisted record whether setup ends ready or failed; branch on the returned status. A bucket is a private folder subtree in your organization's file storage, reached through the Files API with a scoped key. Supply an idempotencyKey to make retries safe — a retry carrying the same key returns the original bucket instead of creating a second one; without a key, every call creates a new bucket.

post/api/v1/buckets

Request

  • Base URL
    https://app.khotan.com
  • URL
    https://app.khotan.com/api/v1/buckets
  • Auth
    • HTTP bearer
    • or API key in header x-api-key

Request body

namestring required
idempotencyKeystring

Response

The persisted bucket record, ready or failed.

idstring required
displayNamestring required
status'creating' | 'ready' | 'failed' required
providerstring required
accessMode'private' | 'public' required
rootFolderIdstring nullable required
protectedboolean required
tagsstring[] required
createdAtstring required
updatedAtstring required
readyAtstring nullable required
failedAtstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.