Records

Endpoints related to managing DNS zone records.

List DNS Zone Records

Requires the dns-view 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 Enum: "creators" "containers"
	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 Zone Records.

default

General error response from the platform

get/v1/dns/zones/{zoneId}/records

Response samples

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"zone_id": "string",
"name": "string",
"resolved_domain": "string",
"type": {"a": {"ip": "string"
},
"aaaa": {"ip": "string"
},
"cname": {"domain": "string"
},
"ns": {"domain": "string"
},
"mx": {"priority": 0,
"domain": "string"
},
"txt": {"value": "string"
},
"alias": {"domain": "string"
},
"srv": {"weight": 0,
"priority": 0,
"port": 0,
"domain": "string"
},
"caa": {"tag": "string",
"value": "string"
},
"linked": {"features": {"tls": {"enable": true
},
"geodns": {"enable": true
}
},
"container_id": "string"
}
},
"features": {"certificate": {"id": "651586fca6078e98982dbd90",
"generated": "2021-01-30T08:30:00Z",
"wildcard_child": true
}
},
"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"
}
}
],
"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": null,
"visitors": null,
"environments": null,
"api_keys": null
},
"containers": {"property1": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"environment": {"id": "651586fca6078e98982dbd90",
"cluster": "string",
"container_subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"subnet": 0,
"ipv4": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
}
}
},
"hub_id": "651586fca6078e98982dbd90",
"image": {"id": "651586fca6078e98982dbd90",
"extension": {"identifier": "string"
},
"service": "discovery"
},
"stack": {"id": "651586fca6078e98982dbd90",
"build_id": "string",
"identifier": "string"
},
"config": {"network": {"public": "enable",
"hostname": "string",
"ports": ["string"
]
},
"deploy": {"instances": 0,
"strategy": "resource-density",
"function": {"max_pool_size": 0,
"max_shard_concurrency": 0,
"max_runtime": "72h45m2s",
"max_queue_time": "72h45m2s"
},
"stateful": {"options": {"use_base_hostname": null
}
},
"constraints": {"node": {"tags": { }
},
"secrets": [null
]
},
"shutdown": {"graceful_timeout": "72h45m2s",
"signals": [null
]
},
"startup": {"delay": "72h45m2s"
},
"update": {"stagger": "72h45m2s"
},
"restart": {"condition": "always",
"delay": "72h45m2s",
"max_attempts": 0
},
"health_check": {"command": "string",
"retries": 0,
"delay": "72h45m2s",
"interval": "72h45m2s",
"timeout": "72h45m2s",
"restart": true
},
"telemetry": {"retention": "72h45m2s",
"interval": "72h45m2s",
"disable": true
}
},
"scale": {"autoscale_group": "string",
"instances": {"max": 0,
"max_server": 0,
"min_ttl": "72h45m2s"
},
"window": "72h45m2s",
"thresholds": [{"type": null,
"details": { }
}
]
},
"runtime": {"command": {"path": "string",
"args": "string"
},
"namespaces": ["ipc"
],
"environment_vars": {"property1": "string",
"property2": "string"
},
"privileged": true,
"capabilities": ["CAP_CHOWN"
],
"workdir": "string",
"sysctl": {"property1": "string",
"property2": "string"
},
"rlimits": {"property1": {"hard": null,
"soft": null
},
"property2": {"hard": null,
"soft": null
}
},
"seccomp": {"disable": true,
"rules": [null
]
},
"host": {"expose_proc": true
},
"rootfs": {"readonly": true
},
"devices": {"shm_size": "64M, 128M, 512M"
}
},
"resources": {"cpu": {"shares": {"limit": null,
"reserve": null
},
"cpus": "string"
},
"ram": {"limit": "1G, 2M",
"reserve": "string"
}
},
"integrations": {"webhooks": {"events": {"deploy": null,
"start": null,
"stop": null
},
"config": "string"
},
"files": [{"source": null,
"destination": null
}
],
"lets_encrypt": {"enable": true,
"certificate_path": "string",
"chain_path": "string",
"key_path": "string",
"bundle_path": "string",
"additional_certs_path": "string"
},
"backups": {"integration_id": "my-image-source",
"backup": {"command": null,
"timeout": null,
"cron_string": null
},
"restore": {"command": null,
"timeout": null
},
"retention": "365d"
},
"shared_file_systems": {"property1": {"writable": null,
"mount_point": null
},
"property2": {"writable": null,
"mount_point": null
}
},
"logs": {"groups": [null
]
}
}
},
"deployment": {"version": "v1.2.3-dev"
},
"instances": 0,
"volumes": [{"id": "651586fca6078e98982dbd90",
"hash": "string",
"config": {"read_only": true,
"local": {"max_size": null,
"storage_pool": null
},
"destination": "string",
"remote_access": {"enable": null,
"ips": [ ],
"webhook": null,
"password": { }
}
}
}
],
"annotations": {"property1": null,
"property2": null
},
"role": "orchestrator",
"stateful": true,
"deprecate": true,
"lock": 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",
"started": "2021-01-30T08:30:00Z"
},
"meta": {"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"domains": [{"fqdn": "string",
"record": {"id": null,
"hub_id": null,
"creator": null,
"zone_id": null,
"name": null,
"resolved_domain": null,
"type": null,
"features": { },
"state": null,
"events": null
}
}
],
"ips": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"kind": "ipv4",
"assignment": {"container_id": null,
"instance_id": null,
"environment_id": null
},
"pool_id": "string",
"address": "string",
"gateway": "string",
"cidr": "string",
"state": {"changed": null,
"error": { }
}
}
]
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"environment": {"id": "651586fca6078e98982dbd90",
"cluster": "string",
"container_subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"subnet": 0,
"ipv4": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
}
}
},
"hub_id": "651586fca6078e98982dbd90",
"image": {"id": "651586fca6078e98982dbd90",
"extension": {"identifier": "string"
},
"service": "discovery"
},
"stack": {"id": "651586fca6078e98982dbd90",
"build_id": "string",
"identifier": "string"
},
"config": {"network": {"public": "enable",
"hostname": "string",
"ports": ["string"
]
},
"deploy": {"instances": 0,
"strategy": "resource-density",
"function": {"max_pool_size": 0,
"max_shard_concurrency": 0,
"max_runtime": "72h45m2s",
"max_queue_time": "72h45m2s"
},
"stateful": {"options": {"use_base_hostname": null
}
},
"constraints": {"node": {"tags": { }
},
"secrets": [null
]
},
"shutdown": {"graceful_timeout": "72h45m2s",
"signals": [null
]
},
"startup": {"delay": "72h45m2s"
},
"update": {"stagger": "72h45m2s"
},
"restart": {"condition": "always",
"delay": "72h45m2s",
"max_attempts": 0
},
"health_check": {"command": "string",
"retries": 0,
"delay": "72h45m2s",
"interval": "72h45m2s",
"timeout": "72h45m2s",
"restart": true
},
"telemetry": {"retention": "72h45m2s",
"interval": "72h45m2s",
"disable": true
}
},
"scale": {"autoscale_group": "string",
"instances": {"max": 0,
"max_server": 0,
"min_ttl": "72h45m2s"
},
"window": "72h45m2s",
"thresholds": [{"type": null,
"details": { }
}
]
},
"runtime": {"command": {"path": "string",
"args": "string"
},
"namespaces": ["ipc"
],
"environment_vars": {"property1": "string",
"property2": "string"
},
"privileged": true,
"capabilities": ["CAP_CHOWN"
],
"workdir": "string",
"sysctl": {"property1": "string",
"property2": "string"
},
"rlimits": {"property1": {"hard": null,
"soft": null
},
"property2": {"hard": null,
"soft": null
}
},
"seccomp": {"disable": true,
"rules": [null
]
},
"host": {"expose_proc": true
},
"rootfs": {"readonly": true
},
"devices": {"shm_size": "64M, 128M, 512M"
}
},
"resources": {"cpu": {"shares": {"limit": null,
"reserve": null
},
"cpus": "string"
},
"ram": {"limit": "1G, 2M",
"reserve": "string"
}
},
"integrations": {"webhooks": {"events": {"deploy": null,
"start": null,
"stop": null
},
"config": "string"
},
"files": [{"source": null,
"destination": null
}
],
"lets_encrypt": {"enable": true,
"certificate_path": "string",
"chain_path": "string",
"key_path": "string",
"bundle_path": "string",
"additional_certs_path": "string"
},
"backups": {"integration_id": "my-image-source",
"backup": {"command": null,
"timeout": null,
"cron_string": null
},
"restore": {"command": null,
"timeout": null
},
"retention": "365d"
},
"shared_file_systems": {"property1": {"writable": null,
"mount_point": null
},
"property2": {"writable": null,
"mount_point": null
}
},
"logs": {"groups": [null
]
}
}
},
"deployment": {"version": "v1.2.3-dev"
},
"instances": 0,
"volumes": [{"id": "651586fca6078e98982dbd90",
"hash": "string",
"config": {"read_only": true,
"local": {"max_size": null,
"storage_pool": null
},
"destination": "string",
"remote_access": {"enable": null,
"ips": [ ],
"webhook": null,
"password": { }
}
}
}
],
"annotations": {"property1": null,
"property2": null
},
"role": "orchestrator",
"stateful": true,
"deprecate": true,
"lock": 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",
"started": "2021-01-30T08:30:00Z"
},
"meta": {"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"domains": [{"fqdn": "string",
"record": {"id": null,
"hub_id": null,
"creator": null,
"zone_id": null,
"name": null,
"resolved_domain": null,
"type": null,
"features": { },
"state": null,
"events": null
}
}
],
"ips": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"kind": "ipv4",
"assignment": {"container_id": null,
"instance_id": null,
"environment_id": null
},
"pool_id": "string",
"address": "string",
"gateway": "string",
"cidr": "string",
"state": {"changed": null,
"error": { }
}
}
]
}
}
},
"containers:identifiers": {"property1": ["651586fca6078e98982dbd90"
],
"property2": ["651586fca6078e98982dbd90"
]
}
}
}

Create DNS Zone Record

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 Record.

required	object (RecordTypes) DNS record types the platform supports.
name required	string A name for the given record where `@` represents the desire to use the root of the origin.

Responses

201

Returns the DNS zone resource.

default

General error response from the platform

post/v1/dns/zones/{zoneId}/records

Request samples

Payload

application/json

{"type": {"a": {"ip": "string"
},
"aaaa": {"ip": "string"
},
"cname": {"domain": "string"
},
"ns": {"domain": "string"
},
"mx": {"priority": 0,
"domain": "string"
},
"txt": {"value": "string"
},
"alias": {"domain": "string"
},
"srv": {"weight": 0,
"priority": 0,
"port": 0,
"domain": "string"
},
"caa": {"tag": "string",
"value": "string"
},
"linked": {"features": {"tls": {"enable": true
},
"geodns": {"enable": true
}
},
"container_id": "string"
}
},
"name": "string"
}

Response samples

201
default

application/json

{"data": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"zone_id": "string",
"name": "string",
"resolved_domain": "string",
"type": {"a": {"ip": "string"
},
"aaaa": {"ip": "string"
},
"cname": {"domain": "string"
},
"ns": {"domain": "string"
},
"mx": {"priority": 0,
"domain": "string"
},
"txt": {"value": "string"
},
"alias": {"domain": "string"
},
"srv": {"weight": 0,
"priority": 0,
"port": 0,
"domain": "string"
},
"caa": {"tag": "string",
"value": "string"
},
"linked": {"features": {"tls": {"enable": true
},
"geodns": {"enable": true
}
},
"container_id": "string"
}
},
"features": {"certificate": {"id": "651586fca6078e98982dbd90",
"generated": "2021-01-30T08:30:00Z",
"wildcard_child": true
}
},
"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"
}
}
}

Update DNS Zone Record

Requires the dns-manage capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

zoneId required	string The ID of the Zone.
recordId required	string The ID of the record.

Request Body schema: application/json

Parameters for updating a DNS Zone Record. The name value cannot be updated and is omitted from the properties.

required

object (RecordTypes)

DNS record types the platform supports.

Responses

200

Returns a DNS Zone Record.

default

General error response from the platform

patch/v1/dns/zones/{zoneId}/records/{recordId}

Request samples

Payload

application/json

{"type": {"a": {"ip": "string"
},
"aaaa": {"ip": "string"
},
"cname": {"domain": "string"
},
"ns": {"domain": "string"
},
"mx": {"priority": 0,
"domain": "string"
},
"txt": {"value": "string"
},
"alias": {"domain": "string"
},
"srv": {"weight": 0,
"priority": 0,
"port": 0,
"domain": "string"
},
"caa": {"tag": "string",
"value": "string"
},
"linked": {"features": {"tls": {"enable": true
},
"geodns": {"enable": true
}
},
"container_id": "string"
}
}
}

Response samples

200
default

application/json

{"data": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"zone_id": "string",
"name": "string",
"resolved_domain": "string",
"type": {"a": {"ip": "string"
},
"aaaa": {"ip": "string"
},
"cname": {"domain": "string"
},
"ns": {"domain": "string"
},
"mx": {"priority": 0,
"domain": "string"
},
"txt": {"value": "string"
},
"alias": {"domain": "string"
},
"srv": {"weight": 0,
"priority": 0,
"port": 0,
"domain": "string"
},
"caa": {"tag": "string",
"value": "string"
},
"linked": {"features": {"tls": {"enable": true
},
"geodns": {"enable": true
}
},
"container_id": "string"
}
},
"features": {"certificate": {"id": "651586fca6078e98982dbd90",
"generated": "2021-01-30T08:30:00Z",
"wildcard_child": true
}
},
"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 Record

Requires the dns-manage capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

zoneId required	string The ID of the Zone.
recordId required	string The ID of the DNS Zone Record.

Responses

202

Returns a Job Descriptor.

default

General error response from the platform

delete/v1/dns/zones/{zoneId}/records/{recordId}

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
}
}
]
}
}
}

Create a DNS Zone Record Job

Used to perform different actions on a given DNS Zone record.

Requires the dns-manage capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

zoneId required	string The ID of the zone.
recordId required	string The ID of the record.

Request Body schema: application/json

Parameters for creating a new DNS Zone Record Job.

action

required

string

The action that the job will take.

Value: "generateCert"

Responses

202

Returns a Job Descriptor.

default

General error response from the platform

post/v1/dns/zones/{zoneId}/records/{recordId}/tasks

Request samples

Payload

application/json

{"action": "generateCert"
}

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 TLS

Records

List DNS Zone Records

path Parameters

query Parameters

Filter Field

Create DNS Zone Record

path Parameters

Request Body schema: application/json

Update DNS Zone Record

path Parameters

Request Body schema: application/json

Delete DNS Zone Record

path Parameters

Create a DNS Zone Record Job

path Parameters

Request Body schema: application/json