Overview
Error Handling

Methods

API Documentation (API Version v1)

Network/DNS/Domain/

DESCRIPTION

This section of the API allows for listing registered domains and renewing those domains.

list

URL:

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

Description:

Returns the list of domain registrations for a given account.

Parameters:

ParameterTypeNotes
domainA fragment of a valid domain name, suitable for partial domain searching
order_byAn associative array containing the values:
 
fieldOne of: 'domain', 'expiration'* 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
 
autorenewA boolean value (0 or 1).* Optional
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
durationOne of: '1', '10', '2', '3', '4', '5', '6', '7', '8', '9'
expirationA valid date and time in YYYY-MM-DD HH:MM:SS format.
is_renewableA boolean value (0 or 1).
renewal_max_yearsA positive integer value (i.e. 1 and up).
renewal_priceA positive monetary value, such as $.05, 0.05, or 5.00* Required if:
  • is_renewable is set to '1'
uniq_idA six-character identifier, containing only capital 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

register

URL:

https://api.stormondemand.com/v1/Network/DNS/Domain/register

Description:

Create a domain registration request.

Parameters:

ParameterTypeNotes
autoRenewA boolean value (0 or 1).
contactAn associative array containing the values:
 
Address1A valid street address, up to 150 characters in length.* Required
Address2A valid street address, up to 150 characters in length.
CityA valid city name.* Required
CountryA valid ISO country code or name.* Required
EmailAddressA valid email address.* Required
FaxA valid phone number.* Required if:
  • OrganizationName is given
FirstNameA valid name, up to 100 characters in length.* Required
JobTitleA string permitting tabs, carriage returns and newlines* Required if:
  • OrganizationName is given
LastNameA valid name, up to 100 characters in length.* Required
OrganizationNameA valid company name, up to 100 characters in length.
PhoneA valid phone number.* Required
PostalCodeA valid postal code.* Required
StateProvinceA valid state or province.* Required
StateProvinceChoiceOne of: 'P', 'S'* Optional
  • Defaults to: S
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Required
durationOne of: '1', '10', '2', '3', '4', '5', '6', '7', '8', '9'* Optional
  • Defaults to: 1
lwtechA boolean value (0 or 1).* Optional
  • Defaults to: 0
nameServersAn array of a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Required
resellerA boolean value (0 or 1).* Optional
  • Defaults to: 0

Returns:

FieldTypeNotes
autorenewA boolean value (0 or 1).* Optional
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
durationOne of: '1', '10', '2', '3', '4', '5', '6', '7', '8', '9'
expirationA valid date and time in YYYY-MM-DD HH:MM:SS format.
is_renewableA boolean value (0 or 1).
renewal_max_yearsA positive integer value (i.e. 1 and up).
renewal_priceA positive monetary value, such as $.05, 0.05, or 5.00* Required if:
  • is_renewable is set to '1'
uniq_idA six-character identifier, containing only capital letters and digits.

Possible Errors:

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

renew

URL:

https://api.stormondemand.com/v1/Network/DNS/Domain/renew

Description:

Renews a domain.

Parameters:

ParameterTypeNotes
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Required
durationOne of: '1', '10', '2', '3', '4', '5', '6', '7', '8', '9'* Optional
  • Defaults to: 1

Returns:

FieldTypeNotes
autorenewA boolean value (0 or 1).* Optional
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
durationOne of: '1', '10', '2', '3', '4', '5', '6', '7', '8', '9'
expirationA valid date and time in YYYY-MM-DD HH:MM:SS format.
is_renewableA boolean value (0 or 1).
renewal_max_yearsA positive integer value (i.e. 1 and up).
renewal_priceA positive monetary value, such as $.05, 0.05, or 5.00* Required if:
  • is_renewable is set to '1'
uniq_idA six-character identifier, containing only capital letters and digits.

Possible Errors:

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