Skip to navigation

Add CDN custom domain

Adds a custom domain to a CDN distribution and returns the DNS records needed to verify it. Requires scope: cdn.write.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# DISTRIBUTION_ID: CDN distribution ID
curl -X POST "https://api.ibee.ai/v1/cdn/distributions/$DISTRIBUTION_ID/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

distribution_idstringRequired>=1 character
CDN distribution ID.

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.
domainstringRequired3-253 characters

Fully qualified hostname to serve, for example cdn.example.com.

Response

Custom domain added successfully.
domainstring
The hostname.
statusenum
  • pending_validation: waiting for the DNS CNAME to be detected.
  • pending_tls: validated; the certificate is being issued.
  • active: certificate issued; the domain serves traffic.
  • failed: validation or certificate issuance failed.
Allowed values:
created_atdatetime

When the hostname was added (ISO 8601).

tls_statusstring or nullOptional
Certificate status reported by the edge provider, when available.
instructionslist of strings or nullOptional
Steps to complete setup, such as the CNAME record to create.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required 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