Nameservers

Fields

  • fqdn - DNScaster’s name for this nameserver. (Read-only)
  • id - DNScaster’s ID for the nameserver, eg: ns_sample123456. (Read-only)
  • instances - 1 or more addressable instances that answer queries for this nameserver. (Read-only)
    • instances.health - Current health status.
    • instances.health_at - Time of last health change.
    • instances.id - DNScaster’s ID for the instance, eg: vps_sample123456.
    • instances.ipv4 - IPv4 address.
    • instances.ipv6 - IPv6 address.
    • instances.object - Always instance.
    • instances.region - Instance location; always matches nameserver region unless migrating between regions.
    • instances.state - active, building, or retiring.
  • nameserver_set_id - Nameserver set to which this nameserver belongs.
  • object - Always nameserver. (Read-only)
  • region - Nameserver location.
  • state - active, building, or inactive. (Read-only)
  • vanity_fqdns - 0 or more Vanity names that point to this nameserver. (Read-only)

List nameservers

Query params
  • nameserver_set_id - Filter by nameserver_set_id.
  • region - Filter by region. Specify multiple as one,two; will be OR’d.
  • Plus standard paging params.
    • sort - Fields: id (default), nameserver_set.
Request
GET /v1/nameservers
Response

On success, 200 with 0 or more nameservers.

{
  "collection": [
    {
      "fqdn": "abc123.dnscstr.com",
      "id": "ns_sample123456",
      "nameserver_set_id": "nst_sample123456",
      "object": "nameserver",
      "region": "us-nyc",
      "state": "active",
      "vanity_fqdns": []
    }
  ],
  "more_results": false
}

Retrieve a nameserver

Request
GET /v1/nameservers/ns_sample123456
Response

On success, 200 with the nameserver.

{
  "fqdn": "abc123.dnscstr.com",
  "id": "ns_sample123456",
  "instances": [
    {
      "health": "online",
      "health_at": 1640995200,
      "id": "vps_sample123456",
      "ipv4": "192.168.0.1",
      "ipv6": "2001:2::1",
      "object": "instance",
      "region": "us-nyc",
      "state": "active"
    }
  ],
  "nameserver_set_id": "nst_sample123456",
  "object": "nameserver",
  "region": "us-nyc",
  "state": "active",
  "vanity_fqdns": []
}

Create a nameserver

Request
POST /v1/nameservers
{
  "nameserver": {
    "nameserver_set_id": "nst_sample123456",
    "region": "us-nyc"
  }
}
Response

On success, 201 with the new nameserver.
On error, 422 with standard error response.

{
  "fqdn": "abc123.dnscstr.com",
  "id": "ns_sample123456",
  "instances": [
    {
      "health": null,
      "health_at": null,
      "id": "vps_sample123456",
      "ipv4": null,
      "ipv6": null,
      "object": "instance",
      "region": "us-nyc",
      "state": "building"
    }
  ],
  "nameserver_set_id": "nst_sample123456",
  "object": "nameserver",
  "region": "us-nyc",
  "state": "building",
  "vanity_fqdns": []
}

Delete a nameserver

Request
DELETE /v1/nameservers/ns_sample123456
Response

On success, 202 with an empty response.
On error, 422 with standard error response.