GET api/NameServer/{name}/Check?registry={registry}&user={user}

Check the availability of a name server on a registry

Request Information

URI Parameters

NameDescriptionTypeAdditional information
name

Name server name

string

Required

registry

Registry id

string

Required

user

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

string

None.

Body Parameters

None.

Response Information

Resource Description

Nameserver check object on success
Collection of errors on failure
Return codes
200 - ok
400 - bad request
401 - unauthorized
404 - not found
500 - internal server error
534 - invalid invalid domain name
535 - invalid invalid name server name

NameServerCheck
NameDescriptionTypeAdditional information
Name

Name

string

None.

Registry

Registry id

string

None.

Available

Is available

boolean

None.

Errors

Errors encountered

Collection of Error

None.

Response Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Registry": "sample string 2",
  "Available": true,
  "Errors": [
    {
      "Code": 1,
      "Detail": "sample string 2",
      "Data": {}
    }
  ]
}

application/xml, text/xml

Sample:
<NameServerCheck xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Domain">
  <Available>true</Available>
  <Errors xmlns:d2p1="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models">
    <d2p1:Error>
      <d2p1:Code>1</d2p1:Code>
      <d2p1:Data />
      <d2p1:Detail>sample string 2</d2p1:Detail>
    </d2p1:Error>
  </Errors>
  <Name>sample string 1</Name>
  <Registry>sample string 2</Registry>
</NameServerCheck>