Overview
Error Handling

Methods

API Documentation (API Version v1)

Network/DNS/Zone/

DESCRIPTION

DNS allows you to point domain names to IP addresses. Each domain name is represented by a DNS zone, which in turns can contain several records of varying types. For more information about the generals of DNS, refer to Wikipedia or some other resource.

This section of the API contains methods for creating and deleting zones from our DNS system, as well as getting information about what zones we are currently serving for you.

create

URL:

https://api.stormondemand.com/v1/Network/DNS/Zone/create

Description:

Add a new DNS zone.

Parameters:

ParameterTypeNotes
nameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Required
region_supportA boolean value (0 or 1).
zone_dataAn associative array containing the values:
 
contactA valid email address.
ipA valid IP address (v4 or v6)
primaryA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
secondaryA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

Returns:

FieldTypeNotes
activeA boolean value (0 or 1).
delegation_checkedA valid date and time in YYYY-MM-DD HH:MM:SS format.* Optional
delegation_statusA string permitting tabs, carriage returns and newlines* Optional
idA positive integer value (i.e. 1 and up).
masterAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
nameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
notified_serialA positive integer value (i.e. 1 and up).* Optional
region_supportA boolean value (0 or 1).* Optional
typeA single word, consisting of only letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

delegation

URL:

https://api.stormondemand.com/v1/Network/DNS/Zone/delegation

Description:

This method can be used to check if a DNS zone is properly delegated to our nameservers.

Parameters:

ParameterTypeNotes
idA positive integer value (i.e. 1 and up).* Required if:
  • name is not given
nameA valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters)* Required if:
  • id is not given

Returns:

FieldType
delegationA single word, consisting of only letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

delete

URL:

https://api.stormondemand.com/v1/Network/DNS/Zone/delete

Description:

Remove a DNS zone.

Parameters:

ParameterTypeNotes
idA positive integer value (i.e. 1 and up).* Required if:
  • name is not given
nameA valid forward DNS Zone name.* Required if:
  • id is not given

Returns:

FieldType
deletedA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

details

URL:

https://api.stormondemand.com/v1/Network/DNS/Zone/details

Description:

Retrieve details on a particular zone served by our DNS servers.

Parameters:

ParameterTypeNotes
idA positive integer value (i.e. 1 and up).* Required if:
  • name is not given
nameA valid forward DNS Zone name.* Required if:
  • id is not given

Returns:

FieldTypeNotes
activeA boolean value (0 or 1).
delegation_checkedA valid date and time in YYYY-MM-DD HH:MM:SS format.* Optional
delegation_statusA string permitting tabs, carriage returns and newlines* Optional
idA positive integer value (i.e. 1 and up).
masterAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
nameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
notified_serialA positive integer value (i.e. 1 and up).* Optional
region_supportA boolean value (0 or 1).* Optional
typeA single word, consisting of only letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

list

URL:

https://api.stormondemand.com/v1/Network/DNS/Zone/list

Description:

Retrieve a list of zones that are served by our DNS servers for your account.

Parameters:

ParameterTypeNotes
delegation_statusOne of: 'BAD_NAMESERVERS', 'CORRECT', 'NXDOMAIN', 'SERVFAIL', 'UNKNOWN'
domainA fragment of a valid domain name, suitable for partial domain searching
order_byAn associative array containing the values:
 
fieldOne of: 'delegation_status', 'domain'* Required
sortOne of: 'asc', 'desc'* Optional
  • Defaults to: desc
page_numA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
page_sizeA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 25

Returns:

FieldType
item_countA non-negative integer value (i.e. 0 and up).
item_totalA non-negative integer value (i.e. 0 and up).
itemsAn array of associative arrays containing
 
activeA boolean value (0 or 1).
delegation_checkedA valid date and time in YYYY-MM-DD HH:MM:SS format.* Optional
delegation_statusA string permitting tabs, carriage returns and newlines* Optional
idA positive integer value (i.e. 1 and up).
masterAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
nameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
notified_serialA positive integer value (i.e. 1 and up).* Optional
region_supportA boolean value (0 or 1).* Optional
typeA single word, consisting of only letters and digits.
page_numA positive integer value (i.e. 1 and up).
page_sizeA positive integer value (i.e. 1 and up).
page_totalA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

update

URL:

https://api.stormondemand.com/v1/Network/DNS/Zone/update

Description:

Update the zone features.

Parameters:

ParameterTypeNotes
DNSRegionSupportA boolean value (0 or 1).
idA positive integer value (i.e. 1 and up).* Required if:
  • name is not given
nameA valid forward DNS Zone name.* Required if:
  • id is not given

Returns:

FieldTypeNotes
activeA boolean value (0 or 1).
delegation_checkedA valid date and time in YYYY-MM-DD HH:MM:SS format.* Optional
delegation_statusA string permitting tabs, carriage returns and newlines* Optional
idA positive integer value (i.e. 1 and up).
masterAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
nameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
notified_serialA positive integer value (i.e. 1 and up).* Optional
region_supportA boolean value (0 or 1).* Optional
typeA single word, consisting of only letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types