Create Custom Domain
Create a new custom domain for a project with DNS validation records.
Authorizations
Service Account Token authentication. To authenticate API requests:
-
Create a Service Account Token:
- Go to the Cerebrium Dashboard and open the API Keys page
- Click Create Service Account, name it (e.g., "GitHub Actions CI/CD"), choose an expiry date, and click Create
- Copy the token generated for the desired service account
-
Use the Token: Include the service account token in the Authorization header of API requests:
Authorization: Bearer <your-service-account-token> -
Best Practices:
- Create separate service accounts for different environments (dev, staging, prod)
- Store tokens securely as secrets in consuming applications or workflows
- Set appropriate expiry dates and rotate tokens regularly
- Never commit tokens to source control
For CI/CD integration examples, see the CI/CD documentation.
Path Parameters
Body
The domain name to add (e.g., api.example.com)
Type of domain. Valid values: apex, subdomain. Wildcard domains are not currently supported.
The region the domain should route to (e.g., us-east-1). Must match the region where the target app is deployed.
Response
The newly created custom domain, including the DNS record you must create to validate ownership.
Timestamp when the domain was created (RFC 3339).
Name of the DNS record to create for validation.
Type of DNS record to create for validation (e.g., CNAME).
Value of the DNS record to create for validation.
The custom domain name.
Type of domain (apex or subdomain).
Unique identifier of the custom domain.
ID of the project the domain belongs to.
The region the domain routes to.
Timestamp when the domain was last updated (RFC 3339).
Current DNS validation status of the domain.