Skip to navigation
API ReferenceObject Storage

Get bucket custom domains

Returns the bucket’s custom domains with their status and the CNAME target to point them at, as the portal’s Settings › Custom domains tab shows. Requires scope: object-storage.read.

# 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 "https://api.ibee.ai/v1/object-storage/buckets/$BUCKET_NAME/custom-domains?workspace_id=$WORKSPACE_ID" \
  -H "Authorization: Bearer $IBEE_API_TOKEN"

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.

Response

Get bucket custom domains succeeded.
cname_targetstring
Hostname every custom domain must CNAME to.
custom_domainslist of objects
idstring or nullOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
503
Service Unavailable Error