Skip to navigation
API ReferenceObject Storage

Add a bucket custom domain

Adds a custom hostname that serves the bucket. Create the CNAME record shown in cname_target, then check status on the list. Requires scope: object-storage.write.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# BUCKET_NAME: Logical bucket name
curl -X POST "https://api.ibee.ai/v1/object-storage/buckets/$BUCKET_NAME/custom-domains?workspace_id=$WORKSPACE_ID" \
  -H "Authorization: Bearer $IBEE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"domain": "<domain>"}'

Authentication

AuthorizationBearer

IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.

Path parameters

bucket_namestringRequired
Logical bucket name.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

Request

This endpoint expects an object.
domainstringRequired

Hostname to serve the bucket from, for example assets.example.com.

Response

Add a bucket custom domain succeeded.
domainstring
statusstring

Current state of the hostname (DNS check and TLS).

cname_targetstringOptional
Hostname the CNAME record must point at.
created_atdatetime or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
423
Locked Error
503
Service Unavailable Error