POST api/NameServer?user={user}

Register a name server

Request Information

URI Parameters

NameDescriptionTypeAdditional information
user

Optional user handle - if empty logged in user will be used

string

None.

Body Parameters

New name server details

NewNameServer
NameDescriptionTypeAdditional information
Name

string

Required

Ip1

Primary ip address

string

Required

Ip2

Second ip address

string

None.

Registry

Registry info

string

Required

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Ip1": "sample string 2",
  "Ip2": "sample string 3",
  "Registry": "sample string 4"
}

application/xml, text/xml

Sample:
<NewNameServer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Domain">
  <Ip1>sample string 2</Ip1>
  <Ip2>sample string 3</Ip2>
  <Name>sample string 1</Name>
  <Registry>sample string 4</Registry>
</NewNameServer>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Nameserver object on success
Collection of errors on failure
Return codes
200 - ok
300 - ambiguous
400 - bad request
401 - unauthorized
404 - not found
500 - internal server error
510 - object does not exist
525 - internal server error
530 - object already registered
550 - parameter value policy error
570 - object status does not allow for operation
581 - command failed

NameServer
NameDescriptionTypeAdditional information
Id

decimal number

None.

Name

string

Required

Ip1

Primary ip address

string

None.

Ip2

Second ip address

string

None.

Registries

Registry info

Collection of NSHandle

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1.0,
  "Name": "sample string 2",
  "Ip1": "sample string 3",
  "Ip2": "sample string 4",
  "Registries": [
    {
      "Registry": "sample string 1",
      "Handle": "sample string 2",
      "RegisterDate": "2024-07-10T01:24:54.0915743+02:00"
    }
  ]
}

application/xml, text/xml

Sample:
<NameServer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Domain">
  <Id>1</Id>
  <Ip1>sample string 3</Ip1>
  <Ip2>sample string 4</Ip2>
  <Name>sample string 2</Name>
  <Registries>
    <NSHandle>
      <Handle>sample string 2</Handle>
      <RegisterDate>2024-07-10T01:24:54.0915743+02:00</RegisterDate>
      <Registry>sample string 1</Registry>
    </NSHandle>
  </Registries>
</NameServer>