Domains are called zones inside the API.
active
or inactive.
domain
but with international domains rendered in UTF8. (Read-only)zon_sample123456
. (Read-only)zone
. (Read-only)best
, auto-selects the vanity name with a matching .tld, or if none found, the default vanity name.external_ref
.nameserver_set_id
.tags
. Specify multiple as one,two
; will be OR’d.vanity_set_id
.domain
(default), id
.GET /v1/zones
GET /v1/zones?tags=one,two
On success, 200 with 0 or more zones.
{
"collection": [
{
"default_ttl": 900,
"delegation_updates": "inactive",
"domain": "example.com",
"domain_utf8": "example.com",
"external_ref": null,
"glue_updates": "inactive",
"id": "zon_sample123456",
"nameserver_set_id": "nst_sample123456",
"nx_ttl": 900,
"object": "zone",
"tags": [],
"vanity_set_id": null
}
],
"more_results": false
}
Retrieves a zone by the zone ID or domain name.
hosts
in the response.GET /v1/zones/zon_sample123456
GET /v1/zones/example.com
GET /v1/zones/zon_sample123456?expand=hosts
On success, 200 with the zone.
{
"default_ttl": 900,
"delegation_errors": [],
"delegation_updates": "inactive",
"domain": "example.com",
"domain_provider_id": null,
"domain_utf8": "example.com",
"external_ref": null,
"glue_errors": [],
"glue_updates": "inactive",
"hosts": [],
"id": "zon_sample123456",
"in_use": false,
"live_checked_at": null,
"nameserver_set_id": "nst_sample123456",
"notes": null,
"nx_ttl": 900,
"object": "zone",
"synced": true,
"tags": [],
"vanity_set_id": null
}
POST /v1/zones
{
"zone": {
"domain": "example.org",
"nameserver_set_id": "nst_sample123456"
}
}
On success, 201 with the new zone.
On error, 422 with standard error response.
{
"default_ttl": 900,
"delegation_errors": [],
"delegation_updates": "inactive",
"domain": "example.org",
"domain_provider_id": null,
"domain_utf8": "example.org",
"external_ref": null,
"glue_errors": [],
"glue_updates": "inactive",
"id": "zon_sample123456",
"in_use": false,
"live_checked_at": null,
"nameserver_set_id": "nst_sample123456",
"notes": null,
"nx_ttl": 900,
"object": "zone",
"synced": true,
"tags": [],
"vanity_set_id": null
}
PUT /v1/zones/zon_sample123456
PUT /v1/zones/example.com
{
"zone": {
"notes": "DNScaster is amazing!"
}
}
On success, 200 with the updated zone.
On error, 422 with standard error response.
{
"default_ttl": 900,
"delegation_errors": [],
"delegation_updates": "inactive",
"domain": "example.com",
"domain_provider_id": null,
"domain_utf8": "example.com",
"external_ref": null,
"glue_errors": [],
"glue_updates": "inactive",
"id": "zon_sample123456",
"in_use": false,
"live_checked_at": null,
"nameserver_set_id": "nst_sample123456",
"notes": "DNScaster is amazing!",
"nx_ttl": 900,
"object": "zone",
"synced": true,
"tags": [],
"vanity_set_id": null
}
DELETE /v1/zones/zon_sample123456
DELETE /v1/zones/example.com
On success, 202 with an empty response.
On error, 422 with standard error response.
Cause DNScaster to recheck a zone’s delegation and glue (where applicable) status. Will return immediately while the domain is rechecked in the background. Wait a bit and then retrieve the zone to see any updated status.
POST /v1/zones/zon_sample123456/check
POST /v1/zones/example.com/check
On success, 202 with an empty response.