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.
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_name
Logical bucket name.
Query parameters
workspace_id
The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.
Request
This endpoint expects an object.
domain
Hostname to serve the bucket from, for example assets.example.com.
Response
Add a bucket custom domain succeeded.
domain
status
Current state of the hostname (DNS check and TLS).
cname_target
Hostname the CNAME record must point at.
created_at
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
413
Content Too Large Error
422
Unprocessable Entity Error
423
Locked Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error
