Skip to main content
POST
Create 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

Body

application/json
domain
string
required

The domain name to add (e.g., api.example.com)

domainType
string
required

Type of domain. Valid values: apex, subdomain. Wildcard domains are not currently supported.

region
string
required

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.

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

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

validationStatus
string

Current DNS validation status of the domain.