GET api/Zone/{zone_handle}/NsKey?user={user}
Get nskeys associated to the zone object
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| zone_handle |
Handle od the zone |
string |
Required |
| user |
Optional user handle - if empty logged in user will be used |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
List of nskeys on success
Collection of errors on failure
Return codes
200 - ok
401 - unauthorized
404 - not found
500 - internal server error
| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| ZoneName |
Name of the zone |
string |
None. |
| KeyTag | string |
None. |
|
| Algorithm | integer |
None. |
|
| DigestType | integer |
None. |
|
| Digest | string |
None. |
|
| DateInsert | date |
None. |
|
| Active | boolean |
None. |
|
| NbNs |
Namebay hosted |
boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Id": 1,
"ZoneName": "sample string 2",
"KeyTag": "sample string 3",
"Algorithm": 4,
"DigestType": 5,
"Digest": "sample string 6",
"DateInsert": "2025-12-12T19:16:11.576374+01:00",
"Active": true,
"NbNs": true
},
{
"Id": 1,
"ZoneName": "sample string 2",
"KeyTag": "sample string 3",
"Algorithm": 4,
"DigestType": 5,
"Digest": "sample string 6",
"DateInsert": "2025-12-12T19:16:11.576374+01:00",
"Active": true,
"NbNs": true
}
]
application/xml, text/xml
Sample:
<ArrayOfNsKey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Zone">
<NsKey>
<Active>true</Active>
<Algorithm>4</Algorithm>
<DateInsert>2025-12-12T19:16:11.576374+01:00</DateInsert>
<Digest>sample string 6</Digest>
<DigestType>5</DigestType>
<Id>1</Id>
<KeyTag>sample string 3</KeyTag>
<NbNs>true</NbNs>
<ZoneName>sample string 2</ZoneName>
</NsKey>
<NsKey>
<Active>true</Active>
<Algorithm>4</Algorithm>
<DateInsert>2025-12-12T19:16:11.576374+01:00</DateInsert>
<Digest>sample string 6</Digest>
<DigestType>5</DigestType>
<Id>1</Id>
<KeyTag>sample string 3</KeyTag>
<NbNs>true</NbNs>
<ZoneName>sample string 2</ZoneName>
</NsKey>
</ArrayOfNsKey>