Skip to main content
POST
Create Domain

Body

application/json

Inputs to allocate a domain. Set parentDomainName to nest under a shared wildcard apex (inheriting its certificate); otherwise set the routing target fields to point a custom domain at your load balancer or distribution.

name
string
required

The leaf name when nesting under an apex, or the full domain name for a custom domain.

moduleInstanceId
string

Id of the module instance this domain belongs to. Optional for a runner call (the instance is derived from the run); required for a service-account API key. Must belong to your organization.

parentDomainName
string

The wildcard apex to nest under. When set, the domain becomes <name>.<parentDomainName> and inherits the apex's certificate.

targetDnsName
string

The DNS name to route traffic to (a load balancer or CloudFront distribution domain).

targetZoneId
string

The hosted zone id of the routing target (your load balancer's zone, or Z2FDTNDATAQYW2 for CloudFront).

Response

The request has succeeded and a new resource has been created as a result.

data
object
required

A domain and its current routing, certificate, and DNS-record state. The create-time name/parentDomainName inputs are not returned — changing either replaces the domain.