Get Custom Domain
Retrieve details for a specific custom domain.
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.
Response
The requested custom domain with its validation status and DNS validation record details.
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).
Details of the most recent validation failure. Omitted if there is no error.
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).
Timestamp when the domain was successfully validated (RFC 3339). Omitted if not yet validated.
Current DNS validation status of the domain.