Skip to main content
GET
Get Custom Domain

Authorizations

Authorization
string
header
required

Service Account Token authentication. To authenticate API requests:

  1. 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
  2. Use the Token: Include the service account token in the Authorization header of API requests: Authorization: Bearer <your-service-account-token>

  3. 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

project_id
string
required
domain_id
string
required

Response

The requested custom domain with its validation status and DNS validation record details.

createdAt
string

Timestamp when the domain was created (RFC 3339).

dnsRecordName
string

Name of the DNS record to create for validation.

dnsRecordType
string

Type of DNS record to create for validation (e.g., CNAME).

dnsRecordValue
string

Value of the DNS record to create for validation.

domain
string

The custom domain name.

domainType
string

Type of domain (apex or subdomain).

errorMessage
string

Details of the most recent validation failure. Omitted if there is no error.

id
string

Unique identifier of the custom domain.

projectId
string

ID of the project the domain belongs to.

region
string

The region the domain routes to.

updatedAt
string

Timestamp when the domain was last updated (RFC 3339).

validatedAt
string

Timestamp when the domain was successfully validated (RFC 3339). Omitted if not yet validated.

validationStatus
string

Current DNS validation status of the domain.