Skip to main content
POST
Add a storage bucket

Authorizations

Authorization
string
header
required

Pass an API key or JWT token. API keys can be sent as Authorization: Bearer <key> or Authorization: <key>.

Path Parameters

tenant_id
string
required

The tenant's unique identifier.

Body

application/json
name
string
required

Human-friendly label for this bucket (unique per tenant).

Required string length: 1 - 100
access_key_id
string
required

AWS access key ID.

Required string length: 16 - 128
secret_access_key
string
required

AWS secret access key. Encrypted at rest and never returned.

Minimum string length: 1
default_bucket
string
required

S3 bucket name. Immutable after creation.

Required string length: 3 - 63
set_as_default
boolean
default:false

Make this the tenant's default (fallback) bucket. The first bucket added always becomes the default.

region
string
default:ap-south-1

AWS region of the bucket.

base_path
string
default:file-service/

Key prefix applied to every object written to this bucket. Immutable after creation.

Response

Storage bucket added.

status
enum<string>
Available options:
SUCCESS
message
string
data
object
timestamp
string<date-time>