Skip to content

Create a dns-zone

POST
/dns-zones
object
data
object
provider
required
string
Allowed values: aws azure gcp cloudflare
name
required

Domain name (e.g. example.com) without trailing dot.

string
type
string
Allowed values: public private
provider_zone_id
required

Provider-side zone identifier (Route53 /hostedzone/Z…, Azure ARM path, GCP managed zone name, Cloudflare zone UUID).

string
records_count
integer
status
string
Allowed values: active importing error
organisation
One of:

DocumentId reference to api::organisation.organisation

string
credential
One of:

DocumentId reference to api::cloud-credential.cloud-credential

string
provider_metadata

Provider-specific metadata (name servers, comments, etc.).

Created

object
data
object
provider
required
string
Allowed values: aws azure gcp cloudflare
name
required

Domain name (e.g. example.com) without trailing dot.

string
type
string
Allowed values: public private
provider_zone_id
required

Provider-side zone identifier (Route53 /hostedzone/Z…, Azure ARM path, GCP managed zone name, Cloudflare zone UUID).

string
records_count
integer
status
string
Allowed values: active importing error
organisation
One of:

DocumentId reference to api::organisation.organisation

string
credential
One of:

DocumentId reference to api::cloud-credential.cloud-credential

string
provider_metadata

Provider-specific metadata (name servers, comments, etc.).

documentId
string
id
integer
createdAt
string format: date-time
updatedAt
string format: date-time
publishedAt
string format: date-time
nullable

Validation error

Missing or invalid authentication

Not authorized (tenant scope or capability)