logo

Zones

Endpoints related to DNS zones.

List DNS Zones

Requires the dns-view capability.

SecuritybearerAuth and hubAuth
Request
query Parameters
include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Value: "creators"
object

Filter Field

The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.

sort
Array of strings

An array of sort values. To sort descending, put a - in front of the value, e.g. -id.

object

In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be page[size]=20&page[number]=2

Responses
200

Returns a collection of DNS Zones.

default

General error response from the platform

get/v1/dns/zones
Response samples
application/json
{
  • "data": [
    ],
  • "includes": {
    }
}

Create DNS Zone

Requires the dns-manage capability.

SecuritybearerAuth and hubAuth
Request
Request Body schema: application/json

Parameters for creating a new DNS Zone.

hosted
required
boolean

A boolean where true represents the desire for the origin to be of the type hosted.

origin
required
string

The origin that will be created.

ACL (object) or null
Responses
201

Returns the DNS Zone resource.

default

General error response from the platform

post/v1/dns/zones
Request samples
application/json
{
  • "hosted": true,
  • "origin": "string",
  • "acl": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}

Get DNS Zone

Requires the dns-view capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
zoneId
required
string

The ID of the zone.

Responses
200

Returns a DNS zone resource.

default

General error response from the platform

get/v1/dns/zones/{zoneId}
Response samples
application/json
{
  • "data": {
    }
}

Update DNS Zone

Requires the dns-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
zoneId
required
string

The ID of the zone.

query Parameters
include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Value: "creators"
Request Body schema: application/json

Parameters for updating a DNS Zone.

hosted
boolean or null

A boolean where true represents the desire for the origin to be of the type hosted.

Responses
200

Returns a DNS zone resource.

default

General error response from the platform

patch/v1/dns/zones/{zoneId}
Request samples
application/json
{
  • "hosted": true
}
Response samples
application/json
{
  • "data": {
    },
  • "includes": {
    }
}

Delete DNS Zone

Requires the dns-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
zoneId
required
string

The ID of the zone.

Responses
202

Returns a Job Descriptor.

default

General error response from the platform

delete/v1/dns/zones/{zoneId}
Response samples
application/json
{
  • "data": {
    }
}

Update DNS Zone Access

Requires the dns-manage capability, and if an ACL is present, the manage privilege.

SecuritybearerAuth and hubAuth
Request
path Parameters
zoneId
required
string

The ID of the zone.

query Parameters
include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Value: "creators"
Request Body schema: application/json

Parameters for updating a DNS Zone.

ACL (object) or null
Responses
200

Returns a DNS zone.

default

General error response from the platform

patch/v1/dns/zones/{zoneId}/access
Request samples
application/json
{
  • "acl": {
    }
}
Response samples
application/json
{
  • "data": {
    },
  • "includes": {
    }
}

Create DNS Zone Job

Used to perform different actions on a given DNS zone.

Requires the dns-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
zoneId
required
string

The ID of the zone.

Request Body schema: application/json

Parameters for creating a new DNS zone job.

action
required
string

The action that the job will take.

Value: "verify"
Responses
202

Returns a Job Descriptor.

default

General error response from the platform

post/v1/dns/zones/{zoneId}/tasks
Request samples
application/json
{
  • "action": "verify"
}
Response samples
application/json
{
  • "data": {
    }
}
➔ Next to Records