Docs API Nameserver sets

Nameserver sets

Fields

  • external_ref - Arbitrary identifier used to cross reference this nameserver set with a record in your app.
  • hostmaster - Hostmaster email to use in SOA records. If null, uses DNScaster default.
  • id - DNScaster’s ID for the nameserver set, eg: nst_sample123456. (Read-only)
  • in_use - When true, ineligible to be deleted (likely still has nameservers or zones). (Read-only)
  • ip_ttl - TTL (cache time) of all A and AAAA records that correspond to generated NS records. In seconds.
  • name - A descriptive name of the nameserver set.
  • ns_ttl - TTL (cache time) of all generated NS records. In seconds.
  • object - Always nameserver_set. (Read-only)

List nameserver sets

Query params
  • external_ref - Filter by external_ref.
  • Plus standard paging params.
    • sort - Fields: id (default), name.
Request
GET /v1/nameserver_sets
Response

On success, 200 with 0 or more nameserver sets.

{
  "collection": [
    {
      "external_ref": null,
      "hostmaster": null,
      "id": "nst_sample123456",
      "ip_ttl": 900,
      "name": "NS Set 1",
      "ns_ttl": 10800,
      "object": "nameserver_set"
    }
  ],
  "more_results": false
}

Retrieve a nameserver set

Request
GET /v1/nameserver_sets/nst_sample123456
Response

On success, 200 with the nameserver set.

{
  "external_ref": null,
  "hostmaster": null,
  "id": "nst_sample123456",
  "in_use": false,
  "ip_ttl": 900,
  "name": "NS Set 1",
  "ns_ttl": 10800,
  "object": "nameserver_set"
}

Create a nameserver set

Request
POST /v1/nameserver_sets

{
  "nameserver_set": {
    "name": "Number two"
  }
}
Response

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

{
  "external_ref": null,
  "hostmaster": null,
  "id": "nst_sample123456",
  "in_use": false,
  "ip_ttl": 900,
  "name": "Number two",
  "ns_ttl": 10800,
  "object": "nameserver_set"
}

Update a nameserver set

Request
PUT /v1/nameserver_sets/nst_sample123456

{
  "nameserver_set": {
    "ns_ttl": 10800
  }
}
Response

On success, 200 with the updated nameserver set.
On error, 422 with standard error response.

{
  "external_ref": null,
  "hostmaster": null,
  "id": "nst_sample123456",
  "in_use": false,
  "ip_ttl": 900,
  "name": "NS Set 1",
  "ns_ttl": 10800,
  "object": "nameserver_set"
}

Delete a nameserver set

Request
DELETE /v1/nameserver_sets/nst_sample123456
Response

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