POST api/Zone/{zone_handle}/NsKey?user={user}

Create a new ns key on a zone

Request Information

URI Parameters

Name	Description	Type	Additional information
zone_handle	Handle of zone	string	Required
user	Optional user handle - if empty logged in user will be used	string	None.

Body Parameters

New ns key details

NewNsKey

Name	Type	Additional information
KeyTag	string	Required
Algorithm	integer	Required
DigestType	integer	Required
Digest	string	Required

Request Formats

application/json, text/json

Sample:

{
  "KeyTag": "sample string 1",
  "Algorithm": 1,
  "DigestType": 1,
  "Digest": "sample string 2"
}

application/xml, text/xml

Sample:

<NewNsKey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Zone">
  <Algorithm>1</Algorithm>
  <Digest>sample string 2</Digest>
  <DigestType>1</DigestType>
  <KeyTag>sample string 1</KeyTag>
</NewNsKey>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'NewNsKey'.

Response Information

Resource Description

ns key object on success
Collection of errors on failure
Return codes
200 - ok
300 - ambiguous
401 - unauthorized
404 - not found
500 - internal server error
525 - object already registered
696 - Zone hosted by namebay

NsKey

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-13T16:36:05.3968325+01:00",
  "Active": true,
  "NbNs": true
}

application/xml, text/xml

Sample:

<NsKey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Zone">
  <Active>true</Active>
  <Algorithm>4</Algorithm>
  <DateInsert>2025-12-13T16:36:05.3968325+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>