GET api/Zone/{zone_handle}?user={user}

Get zone with handle zone_handle

Request Information

URI Parameters

NameDescriptionTypeAdditional information
zone_handle

Handle of zone to return

 string

Required
user

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

 string

None.

Body Parameters

None.

Response Information

Resource Description

zone object on success
Collection of errors on failure
Return codes
200 - ok
300 - ambiguous
401 - unauthorized
404 - not found
500 - internal server error

Zone
NameDescriptionTypeAdditional information
Handle

Zone handle

string

None.
Name

Zone name

string

Required

String length: inclusive between 1 and 255
SoaExpire

integer

Range: inclusive between 1209600 and 2419200
SoaMinimum

integer

Range: inclusive between 3600 and 86400
SoaPrimaryNs

string

Required

String length: inclusive between 1 and 200
SoaSerial

Used To refresh the zone, When the serial changes Bind knows the zone has to be refreshed. This field is updated automaticaly on zone changes

string

None.
SoaRefresh

integer

Range: inclusive between 1200 and 43200
SoaRespPerson

string

String length: inclusive between 0 and 200
SoaRetry

integer

Range: inclusive between 180 and 900
Ttl

Time to live

integer

Range: inclusive between 0 and 2147483647

Response Formats

application/json, text/json

Sample: 
{
  "Handle": "sample string 1",
  "Name": "sample string 2",
  "SoaExpire": 3,
  "SoaMinimum": 4,
  "SoaPrimaryNs": "sample string 5",
  "SoaSerial": "sample string 6",
  "SoaRefresh": 7,
  "SoaRespPerson": "sample string 8",
  "SoaRetry": 9,
  "Ttl": 10
}

application/xml, text/xml

Sample: 
<Zone xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Zone">
  <Handle>sample string 1</Handle>
  <Name>sample string 2</Name>
  <SoaExpire>3</SoaExpire>
  <SoaMinimum>4</SoaMinimum>
  <SoaPrimaryNs>sample string 5</SoaPrimaryNs>
  <SoaRefresh>7</SoaRefresh>
  <SoaRespPerson>sample string 8</SoaRespPerson>
  <SoaRetry>9</SoaRetry>
  <SoaSerial>sample string 6</SoaSerial>
  <Ttl>10</Ttl>
</Zone>