v1

latestOpenAPI 3.1.02026-07-244861122.7 KB
zones

Create a zone

Create a zone and request its publication. When the zone gets published, it becomes resolvable on the primary nameservers.

post/v1/dns/zones

Request body

namestring required

The name of the zone.

request_publicationboolean nullable

Zone is to published (resolvable on Internet) upon creation

serial_epochinteger nullable

Initial serial number to use in published zone data (default: 1)

zone_authoritystring

Identifier

A string type that has a limited character set, which makes it useful as an easy to type identifier for use in things like URL paths. The restrictions are alphanumeric characters (Unicode is permitted), plus dashes and underscore except for the initial character.

nx_ttlinteger nullable
metadataMetadata

A collection of string key/value pairs that provide additional information or classification for an object.

Example request

{
  "name": "example.com",
  "request_publication": true,
  "serial_epoch": 42,
  "nx_ttl": 60,
  "metadata": {
    "property": "value"
  }
}

Response

resource created