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

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"origin": "string",
"hosted": true,
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"last_verification": "2021-01-30T08:30:00Z",
"verified": "2021-01-30T08:30:00Z"
}
}
],
"includes": {"creators": {"accounts": {"property1": {"name": {"first": "string",
"last": "string"
},
"email": {"address": "string"
},
"id": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
},
"property2": {"name": {"first": "string",
"last": "string"
},
"email": {"address": "string"
},
"id": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
}
},
"employees": {"property1": {"name": {"first": "string",
"last": "string"
},
"email": {"address": "string"
},
"id": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
},
"property2": {"name": {"first": "string",
"last": "string"
},
"email": {"address": "string"
},
"id": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
}
},
"visitors": {"property1": {"name": {"first": "string",
"last": "string"
},
"email": {"address": "string"
},
"id": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
},
"property2": {"name": {"first": "string",
"last": "string"
},
"email": {"address": "string"
},
"id": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
}
},
"environments": {"property1": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"cluster": "string",
"about": {"description": "string",
"favorite": true
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"features": {"legacy_networking": true,
"monitoring": {"tier": "limited"
}
},
"services": {"loadbalancer": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"ipv4": null,
"ipv6": null,
"type": null,
"details": null,
"bind_host": null
}
},
"discovery": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"empty_set_delay": null,
"hosts": { },
"custom_resolvers": [ ]
}
},
"vpn": {"enable": true,
"container_id": "string",
"auto_update": true,
"config": {"allow_internet": null,
"auth": { }
}
},
"scheduler": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"public": null,
"access_keys": [ ]
}
}
},
"acl": {"roles": {"property1": {"view": null,
"modify": null,
"manage": null
},
"property2": {"view": null,
"modify": null,
"manage": null
}
}
},
"private_network": {"vxlan_tag": 0,
"subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"subnet": 0,
"ipv4": {"ip": null,
"cidr": null
}
}
},
"deployments": {"tags": {"property1": "v1.2.3-dev",
"property2": "v1.2.3-dev"
}
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"containers": [{"id": null,
"name": null,
"state": null,
"image": null,
"environment": null
}
]
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"cluster": "string",
"about": {"description": "string",
"favorite": true
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"features": {"legacy_networking": true,
"monitoring": {"tier": "limited"
}
},
"services": {"loadbalancer": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"ipv4": null,
"ipv6": null,
"type": null,
"details": null,
"bind_host": null
}
},
"discovery": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"empty_set_delay": null,
"hosts": { },
"custom_resolvers": [ ]
}
},
"vpn": {"enable": true,
"container_id": "string",
"auto_update": true,
"config": {"allow_internet": null,
"auth": { }
}
},
"scheduler": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"public": null,
"access_keys": [ ]
}
}
},
"acl": {"roles": {"property1": {"view": null,
"modify": null,
"manage": null
},
"property2": {"view": null,
"modify": null,
"manage": null
}
}
},
"private_network": {"vxlan_tag": 0,
"subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"subnet": 0,
"ipv4": {"ip": null,
"cidr": null
}
}
},
"deployments": {"tags": {"property1": "v1.2.3-dev",
"property2": "v1.2.3-dev"
}
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"containers": [{"id": null,
"name": null,
"state": null,
"image": null,
"environment": null
}
]
}
}
},
"api_keys": {"property1": {"id": "651586fca6078e98982dbd90",
"name": "string",
"hub_id": "651586fca6078e98982dbd90",
"secret": "string",
"permissions": {"all_environments": true,
"environments": [{"id": null,
"manage": null
}
]
},
"capabilities": {"all": true,
"specific": ["string"
]
},
"ips": ["string"
],
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z"
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"name": "string",
"hub_id": "651586fca6078e98982dbd90",
"secret": "string",
"permissions": {"all_environments": true,
"environments": [{"id": null,
"manage": null
}
]
},
"capabilities": {"all": true,
"specific": ["string"
]
},
"ips": ["string"
],
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z"
}
}
}
}
}
}

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

Payload

application/json

{"hosted": true,
"origin": "string",
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
}
}

Response samples

201
default

application/json

{"data": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"origin": "string",
"hosted": true,
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"last_verification": "2021-01-30T08:30:00Z",
"verified": "2021-01-30T08:30:00Z"
}
}
}

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

200
default

application/json

{"data": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"origin": "string",
"hosted": true,
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"last_verification": "2021-01-30T08:30:00Z",
"verified": "2021-01-30T08:30:00Z"
}
}
}

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

Payload

application/json

{"hosted": true
}

Response samples

200
default

application/json

{"data": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"origin": "string",
"hosted": true,
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"last_verification": "2021-01-30T08:30:00Z",
"verified": "2021-01-30T08:30:00Z"
}
},
"includes": {"creators": {"accounts": {"property1": {"name": {"first": "string",
"last": "string"
},
"email": {"address": "string"
},
"id": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
},
"property2": {"name": {"first": "string",
"last": "string"
},
"email": {"address": "string"
},
"id": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
}
},
"employees": {"property1": {"name": {"first": "string",
"last": "string"
},
"email": {"address": "string"
},
"id": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
},
"property2": {"name": {"first": "string",
"last": "string"
},
"email": {"address": "string"
},
"id": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
}
},
"visitors": {"property1": {"name": {"first": "string",
"last": "string"
},
"email": {"address": "string"
},
"id": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
},
"property2": {"name": {"first": "string",
"last": "string"
},
"email": {"address": "string"
},
"id": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
}
},
"environments": {"property1": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"cluster": "string",
"about": {"description": "string",
"favorite": true
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"features": {"legacy_networking": true,
"monitoring": {"tier": "limited"
}
},
"services": {"loadbalancer": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"ipv4": null,
"ipv6": null,
"type": null,
"details": null,
"bind_host": null
}
},
"discovery": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"empty_set_delay": null,
"hosts": { },
"custom_resolvers": [ ]
}
},
"vpn": {"enable": true,
"container_id": "string",
"auto_update": true,
"config": {"allow_internet": null,
"auth": { }
}
},
"scheduler": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"public": null,
"access_keys": [ ]
}
}
},
"acl": {"roles": {"property1": {"view": null,
"modify": null,
"manage": null
},
"property2": {"view": null,
"modify": null,
"manage": null
}
}
},
"private_network": {"vxlan_tag": 0,
"subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"subnet": 0,
"ipv4": {"ip": null,
"cidr": null
}
}
},
"deployments": {"tags": {"property1": "v1.2.3-dev",
"property2": "v1.2.3-dev"
}
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"containers": [{"id": null,
"name": null,
"state": null,
"image": null,
"environment": null
}
]
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"cluster": "string",
"about": {"description": "string",
"favorite": true
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"features": {"legacy_networking": true,
"monitoring": {"tier": "limited"
}
},
"services": {"loadbalancer": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"ipv4": null,
"ipv6": null,
"type": null,
"details": null,
"bind_host": null
}
},
"discovery": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"empty_set_delay": null,
"hosts": { },
"custom_resolvers": [ ]
}
},
"vpn": {"enable": true,
"container_id": "string",
"auto_update": true,
"config": {"allow_internet": null,
"auth": { }
}
},
"scheduler": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"public": null,
"access_keys": [ ]
}
}
},
"acl": {"roles": {"property1": {"view": null,
"modify": null,
"manage": null
},
"property2": {"view": null,
"modify": null,
"manage": null
}
}
},
"private_network": {"vxlan_tag": 0,
"subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"subnet": 0,
"ipv4": {"ip": null,
"cidr": null
}
}
},
"deployments": {"tags": {"property1": "v1.2.3-dev",
"property2": "v1.2.3-dev"
}
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"containers": [{"id": null,
"name": null,
"state": null,
"image": null,
"environment": null
}
]
}
}
},
"api_keys": {"property1": {"id": "651586fca6078e98982dbd90",
"name": "string",
"hub_id": "651586fca6078e98982dbd90",
"secret": "string",
"permissions": {"all_environments": true,
"environments": [{"id": null,
"manage": null
}
]
},
"capabilities": {"all": true,
"specific": ["string"
]
},
"ips": ["string"
],
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z"
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"name": "string",
"hub_id": "651586fca6078e98982dbd90",
"secret": "string",
"permissions": {"all_environments": true,
"environments": [{"id": null,
"manage": null
}
]
},
"capabilities": {"all": true,
"specific": ["string"
]
},
"ips": ["string"
],
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z"
}
}
}
}
}
}

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

202
default

application/json

{"data": {"action": "string",
"job": {"id": "string",
"accepted": true,
"queue": "string",
"schedule": "2021-01-30T08:30:00Z",
"parallel": {"sub_queue": "string",
"tasks": true
},
"tasks": [{"caption": "string",
"header": "string",
"steps": [{"caption": "string",
"description": "string",
"started": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z"
}
],
"input": {"property1": null,
"property2": null
}
}
]
}
}
}

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

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

Payload

application/json

{"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
}
}

Response samples

200
default

application/json

{"data": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"origin": "string",
"hosted": true,
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"last_verification": "2021-01-30T08:30:00Z",
"verified": "2021-01-30T08:30:00Z"
}
},
"includes": {"creators": {"accounts": {"property1": {"name": {"first": "string",
"last": "string"
},
"email": {"address": "string"
},
"id": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
},
"property2": {"name": {"first": "string",
"last": "string"
},
"email": {"address": "string"
},
"id": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
}
},
"employees": {"property1": {"name": {"first": "string",
"last": "string"
},
"email": {"address": "string"
},
"id": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
},
"property2": {"name": {"first": "string",
"last": "string"
},
"email": {"address": "string"
},
"id": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
}
},
"visitors": {"property1": {"name": {"first": "string",
"last": "string"
},
"email": {"address": "string"
},
"id": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
},
"property2": {"name": {"first": "string",
"last": "string"
},
"email": {"address": "string"
},
"id": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
}
},
"environments": {"property1": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"cluster": "string",
"about": {"description": "string",
"favorite": true
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"features": {"legacy_networking": true,
"monitoring": {"tier": "limited"
}
},
"services": {"loadbalancer": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"ipv4": null,
"ipv6": null,
"type": null,
"details": null,
"bind_host": null
}
},
"discovery": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"empty_set_delay": null,
"hosts": { },
"custom_resolvers": [ ]
}
},
"vpn": {"enable": true,
"container_id": "string",
"auto_update": true,
"config": {"allow_internet": null,
"auth": { }
}
},
"scheduler": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"public": null,
"access_keys": [ ]
}
}
},
"acl": {"roles": {"property1": {"view": null,
"modify": null,
"manage": null
},
"property2": {"view": null,
"modify": null,
"manage": null
}
}
},
"private_network": {"vxlan_tag": 0,
"subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"subnet": 0,
"ipv4": {"ip": null,
"cidr": null
}
}
},
"deployments": {"tags": {"property1": "v1.2.3-dev",
"property2": "v1.2.3-dev"
}
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"containers": [{"id": null,
"name": null,
"state": null,
"image": null,
"environment": null
}
]
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"cluster": "string",
"about": {"description": "string",
"favorite": true
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"features": {"legacy_networking": true,
"monitoring": {"tier": "limited"
}
},
"services": {"loadbalancer": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"ipv4": null,
"ipv6": null,
"type": null,
"details": null,
"bind_host": null
}
},
"discovery": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"empty_set_delay": null,
"hosts": { },
"custom_resolvers": [ ]
}
},
"vpn": {"enable": true,
"container_id": "string",
"auto_update": true,
"config": {"allow_internet": null,
"auth": { }
}
},
"scheduler": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"public": null,
"access_keys": [ ]
}
}
},
"acl": {"roles": {"property1": {"view": null,
"modify": null,
"manage": null
},
"property2": {"view": null,
"modify": null,
"manage": null
}
}
},
"private_network": {"vxlan_tag": 0,
"subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"subnet": 0,
"ipv4": {"ip": null,
"cidr": null
}
}
},
"deployments": {"tags": {"property1": "v1.2.3-dev",
"property2": "v1.2.3-dev"
}
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"containers": [{"id": null,
"name": null,
"state": null,
"image": null,
"environment": null
}
]
}
}
},
"api_keys": {"property1": {"id": "651586fca6078e98982dbd90",
"name": "string",
"hub_id": "651586fca6078e98982dbd90",
"secret": "string",
"permissions": {"all_environments": true,
"environments": [{"id": null,
"manage": null
}
]
},
"capabilities": {"all": true,
"specific": ["string"
]
},
"ips": ["string"
],
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z"
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"name": "string",
"hub_id": "651586fca6078e98982dbd90",
"secret": "string",
"permissions": {"all_environments": true,
"environments": [{"id": null,
"manage": null
}
]
},
"capabilities": {"all": true,
"specific": ["string"
]
},
"ips": ["string"
],
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z"
}
}
}
}
}
}

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

Payload

application/json

{"action": "verify"
}

Response samples

202
default

application/json

{"data": {"action": "string",
"job": {"id": "string",
"accepted": true,
"queue": "string",
"schedule": "2021-01-30T08:30:00Z",
"parallel": {"sub_queue": "string",
"tasks": true
},
"tasks": [{"caption": "string",
"header": "string",
"steps": [{"caption": "string",
"description": "string",
"started": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z"
}
],
"input": {"property1": null,
"property2": null
}
}
]
}
}
}

➔ Next to Records

Zones

List DNS Zones

query Parameters

Filter Field

Create DNS Zone

Request Body schema: application/json

Get DNS Zone

path Parameters

Update DNS Zone

path Parameters

query Parameters

Request Body schema: application/json

Delete DNS Zone

path Parameters

Update DNS Zone Access

path Parameters

query Parameters

Request Body schema: application/json

Create DNS Zone Job

path Parameters

Request Body schema: application/json