List DNS zones
This endpoint allows you to list DNS zones hosted on Nameshield nameservers.
Many results can be returned, so a pagination system is provided with the limit and offset parameters.
You can also use filters to search for specific zones.
Endpoint
GET /dns/v3/zones
Parameters
| Name | Location | Required | Type | Default value | Description |
|---|---|---|---|---|---|
| limit | URL | No | Integer | 100 | Number of zones to return (max 500) |
| offset | URL | No | Integer | 0 | Offset used |
| sort | URL | No | String | name | Field used to sort zones. Allowed values : name, id |
| name | URL | No | String | Search by zone name. Wildcard compatible | |
| status | URL | No | String | Search by zone status. Allowed values :
| |
| dnssec_status | URL | No | String | Search by DNSSEC status. Allowed values :
| |
| strategic | URL | No | Boolean | Search by strategic property of the zone | |
| customer_id | URL | No | Integer | Search by customer ID. | |
| include_subsidiaries | URL | No | Boolean | true | Include subsidiaries in the search. |
| parent_zone | URL | No | String | Search by parent zone name to find associated subzones. Wildcard compatible | |
| dns_hosting_only | URL | No | Boolean | Filter on zones with dns hosting only or associated with a domain registered with Nameshield | |
| managed_primary_dns | URL | No | Boolean | Filter on zones with a primary nameserver managed by Nameshield | |
| nameserver | URL | No | String | Search by nameserver. Wildcard compatible |
Response
A ZoneSearchResults object.
Example Request
GET /dns/v3/zones?limit=2&offset=2&name=nameshield.*&status=ACTIVE&strategic=true&dnssec_status=SECURED
Example Response
{
"message": "OK",
"data": {
"total": 100,
"limit": 2,
"offset": 2,
"results": [
{
"id": 100000,
"customer_id": 123,
"name": "nameshield.co.jp",
"status": "ACTIVE",
"dnssec_status": "SECURED",
"strategic": true,
"dns_hosting_only": false, |
"managed_primary_dns": true, |
"nameservers": [
{
"name": "nsa.perf1.fr",
"primary": true
},
{
"name": "nsb.perf1.com",
"primary": false
},
{
"name": "nsc.perf1.com",
"primary": false
}
]
},
{
"id": 102345,
"customer_id": 123,
"name": "nameshield.co.nz",
"status": "ACTIVE",
"dnssec_status": "SECURED",
"strategic": true,
"dns_hosting_only": false, |
"managed_primary_dns": true, |
"nameservers": [
{
"name": "nsa.perf1.fr",
"primary": true
},
{
"name": "nsb.perf1.com",
"primary": false
},
{
"name": "nsc.perf1.com",
"primary": false
}
]
}
]
}
}