Overview
Error Handling

Methods

API Documentation (API Version bleed)

Network/DNS/Domain/

DESCRIPTION

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

autoRenew

URL:

https://api.liquidweb.com/bleed/Network/DNS/Domain/autoRenew

Description:

Turns autorenewal On or Off.

Parameters:

ParameterTypeNotes
allowA boolean value (0 or 1).* Required
subaccntA positive integer value (i.e. 1 and up).* Required if:
  • uniq_id is not given
uniq_idA six-character identifier, containing only capital letters and digits.

Returns:

FieldType
allowA boolean value (0 or 1).
domainA 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.liquidweb.com/bleed/Network/DNS/Domain/details

Description:

Parameters:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Required

Returns:

FieldTypeNotes
autorenewA boolean value (0 or 1).* Optional
autorenew_onlyA boolean value (0 or 1).
autorenew_valueOne of: 'Disabled', 'Off', 'On', 'Registration.AutoRenew'
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.
has_privacyA boolean value (0 or 1).
is_expiredA boolean value (0 or 1).
is_renewableA boolean value (0 or 1).
is_rgpA boolean value (0 or 1).
is_transferA boolean value (0 or 1).
privacyOne of: 'Disabled', 'Off', 'On'
privacy_allowedA boolean value (0 or 1).
redemption_order_idA string of text, containing no newlines or other control characters.* Optional
redemption_priceA positive monetary value, such as $.05, 0.05, or 5.00* Required if:
  • is_rgp is set to '1'
renewal_max_yearsA positive integer value (i.e. 1 and up).* Optional
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

disablePrivacy

URL:

https://api.liquidweb.com/bleed/Network/DNS/Domain/disablePrivacy

Description:

Parameters:

ParameterTypeNotes
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
successA boolean value (0 or 1).

Possible Errors:

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

enablePrivacy

URL:

https://api.liquidweb.com/bleed/Network/DNS/Domain/enablePrivacy

Description:

Parameters:

ParameterTypeNotes
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
successA boolean value (0 or 1).

Possible Errors:

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

list

URL:

https://api.liquidweb.com/bleed/Network/DNS/Domain/list

Description:

Returns the list of domain registrations for a given account.

Parameters:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
domainA fragment of a valid domain name, suitable for partial domain searching
order_byAn associative array containing the fields:
 
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
transfersA boolean value (0 or 1).* Optional
  • Defaults to: 0
uniq_idA six-character identifier, containing only capital letters and digits.

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
autorenew_onlyA boolean value (0 or 1).
autorenew_valueOne of: 'Disabled', 'Off', 'On', 'Registration.AutoRenew'
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.
has_privacyA boolean value (0 or 1).
is_expiredA boolean value (0 or 1).
is_renewableA boolean value (0 or 1).
is_rgpA boolean value (0 or 1).
is_transferA boolean value (0 or 1).
privacyOne of: 'Disabled', 'Off', 'On'
privacy_allowedA boolean value (0 or 1).
redemption_order_idA string of text, containing no newlines or other control characters.* Optional
redemption_priceA positive monetary value, such as $.05, 0.05, or 5.00* Required if:
  • is_rgp is set to '1'
renewal_max_yearsA positive integer value (i.e. 1 and up).* Optional
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

multiRegister

URL:

https://api.liquidweb.com/bleed/Network/DNS/Domain/multiRegister

Description:

Register multimple domain, up to five, at the same time.

Parameters:

ParameterTypeNotes
domainsAn array of associative arrays containing * Required
 
autoRenewA boolean value (0 or 1).* Optional
  • Defaults to: 0
contactAn associative array containing the fields:
 
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
ipA valid IP address (v4 or v6)
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)
parkA boolean value (0 or 1).* Optional
  • Defaults to: 0
privacyA boolean value (0 or 1).* Optional
  • Defaults to: 0
resellerA boolean value (0 or 1).* Optional
  • Defaults to: 0

Returns:

FieldType
resultAn array of associative arrays containing
 
detailsAn associative array containing the fields:* Required if:
  • status is set to 'registered'
 
autorenewA boolean value (0 or 1).* Optional
autorenew_onlyA boolean value (0 or 1).
autorenew_valueOne of: 'Disabled', 'Off', 'On', 'Registration.AutoRenew'
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.
has_privacyA boolean value (0 or 1).
is_expiredA boolean value (0 or 1).
is_renewableA boolean value (0 or 1).
is_rgpA boolean value (0 or 1).
is_transferA boolean value (0 or 1).
privacyOne of: 'Disabled', 'Off', 'On'
privacy_allowedA boolean value (0 or 1).
redemption_order_idA string of text, containing no newlines or other control characters.* Optional
redemption_priceA positive monetary value, such as $.05, 0.05, or 5.00* Required if:
  • is_rgp is set to '1'
renewal_max_yearsA positive integer value (i.e. 1 and up).* Optional
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.
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
statusOne of: 'failed', 'registered'

Possible Errors:

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

purchasePrivacy

URL:

https://api.liquidweb.com/bleed/Network/DNS/Domain/purchasePrivacy

Description:

Parameters:

ParameterTypeNotes
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
methodA string permitting tabs, carriage returns and newlines
successA boolean value (0 or 1).

Possible Errors:

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

register

URL:

https://api.liquidweb.com/bleed/Network/DNS/Domain/register

Description:

Create a domain registration request.

Parameters:

ParameterTypeNotes
autoRenewA boolean value (0 or 1).* Optional
  • Defaults to: 0
contactAn associative array containing the fields:
 
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)
privacyA boolean value (0 or 1).* Optional
  • Defaults to: 0
resellerA boolean value (0 or 1).* Optional
  • Defaults to: 0

Returns:

FieldTypeNotes
autorenewA boolean value (0 or 1).* Optional
autorenew_onlyA boolean value (0 or 1).
autorenew_valueOne of: 'Disabled', 'Off', 'On', 'Registration.AutoRenew'
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.
has_privacyA boolean value (0 or 1).
is_expiredA boolean value (0 or 1).
is_renewableA boolean value (0 or 1).
is_rgpA boolean value (0 or 1).
is_transferA boolean value (0 or 1).
privacyOne of: 'Disabled', 'Off', 'On'
privacy_allowedA boolean value (0 or 1).
redemption_order_idA string of text, containing no newlines or other control characters.* Optional
redemption_priceA positive monetary value, such as $.05, 0.05, or 5.00* Required if:
  • is_rgp is set to '1'
renewal_max_yearsA positive integer value (i.e. 1 and up).* Optional
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

registrationDetails

URL:

https://api.liquidweb.com/bleed/Network/DNS/Domain/registrationDetails

Description:

Parameters:

ParameterTypeNotes
domainEither: a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc); or a valid DNS label, consisting of alphanumeric characters and hyphens, between 1 and 63 characters long* Required
skip_suggested_domainsA boolean value (0 or 1).* Optional
  • Defaults to: 0

Returns:

FieldTypeNotes
availableA boolean value (0 or 1).
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
enabledA boolean value (0 or 1).
extended_attributesAn array of associative arrays containing * Optional
 
descriptionA string permitting tabs, carriage returns and newlines
nameA single word, consisting of only letters, digits, hyphens, and underscores.
optionsAn array of associative arrays containing * Optional
 
descriptionA string permitting tabs, carriage returns and newlines* Optional
requiresA single word, consisting of only letters, digits, hyphens, and underscores.* Optional
titleA string permitting tabs, carriage returns and newlines
valueA single word, consisting of only letters, digits, hyphens, and underscores.
requiredA boolean value (0 or 1).
required_by

An associative array of arbitrary keys and values.

A map of field names to an array of values which cause to dependend value to be required

* Optional
laxA boolean value (0 or 1).
lockableA boolean value (0 or 1).
max_periodOne of: '1', '10', '2', '3', '4', '5', '6', '7', '8', '9'
min_periodOne of: '1', '10', '2', '3', '4', '5', '6', '7', '8', '9'
priceA positive monetary value, such as $.05, 0.05, or 5.00
real_timeA boolean value (0 or 1).
registerableA boolean value (0 or 1).
suggestedAn array of associative arrays containing * Optional
 
availableA boolean value (0 or 1).
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
enabledA boolean value (0 or 1).
extended_attributesAn array of associative arrays containing * Optional
 
descriptionA string permitting tabs, carriage returns and newlines
nameA single word, consisting of only letters, digits, hyphens, and underscores.
optionsAn array of associative arrays containing * Optional
 
descriptionA string permitting tabs, carriage returns and newlines* Optional
requiresA single word, consisting of only letters, digits, hyphens, and underscores.* Optional
titleA string permitting tabs, carriage returns and newlines
valueA single word, consisting of only letters, digits, hyphens, and underscores.
requiredA boolean value (0 or 1).
required_by

An associative array of arbitrary keys and values.

A map of field names to an array of values which cause to dependend value to be required

* Optional
laxA boolean value (0 or 1).
lockableA boolean value (0 or 1).
max_periodOne of: '1', '10', '2', '3', '4', '5', '6', '7', '8', '9'
min_periodOne of: '1', '10', '2', '3', '4', '5', '6', '7', '8', '9'
priceA positive monetary value, such as $.05, 0.05, or 5.00
real_timeA boolean value (0 or 1).
registerableA boolean value (0 or 1).

Possible Errors:

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

renew

URL:

https://api.liquidweb.com/bleed/Network/DNS/Domain/renew

Description:

Renews a domain.

Parameters:

ParameterTypeNotes
autoRenewA boolean value (0 or 1).* Optional
  • Defaults to: 0
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
privacyA boolean value (0 or 1).* Optional
  • Defaults to: 0

Returns:

FieldTypeNotes
autorenewA boolean value (0 or 1).* Optional
autorenew_onlyA boolean value (0 or 1).
autorenew_valueOne of: 'Disabled', 'Off', 'On', 'Registration.AutoRenew'
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.
has_privacyA boolean value (0 or 1).
is_expiredA boolean value (0 or 1).
is_renewableA boolean value (0 or 1).
is_rgpA boolean value (0 or 1).
is_transferA boolean value (0 or 1).
privacyOne of: 'Disabled', 'Off', 'On'
privacy_allowedA boolean value (0 or 1).
redemption_order_idA string of text, containing no newlines or other control characters.* Optional
redemption_priceA positive monetary value, such as $.05, 0.05, or 5.00* Required if:
  • is_rgp is set to '1'
renewal_max_yearsA positive integer value (i.e. 1 and up).* Optional
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

tldDetails

URL:

https://api.liquidweb.com/bleed/Network/DNS/Domain/tldDetails

Description:

Parameters:

ParameterTypeNotes
domainsEither: a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc); or An array of a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Required

Returns:

FieldType
One or more keys matching: a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)An associative array containing the fields:
 
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
enabledA boolean value (0 or 1).
extended_attributesAn array of associative arrays containing * Optional
 
descriptionA string permitting tabs, carriage returns and newlines
nameA single word, consisting of only letters, digits, hyphens, and underscores.
optionsAn array of associative arrays containing * Optional
 
descriptionA string permitting tabs, carriage returns and newlines* Optional
requiresA single word, consisting of only letters, digits, hyphens, and underscores.* Optional
titleA string permitting tabs, carriage returns and newlines
valueA single word, consisting of only letters, digits, hyphens, and underscores.
requiredA boolean value (0 or 1).
required_by

An associative array of arbitrary keys and values.

A map of field names to an array of values which cause to dependend value to be required

* Optional
laxA boolean value (0 or 1).* Optional
lockableA boolean value (0 or 1).
max_periodOne of: '1', '10', '2', '3', '4', '5', '6', '7', '8', '9'
min_periodOne of: '1', '10', '2', '3', '4', '5', '6', '7', '8', '9'
priceA positive monetary value, such as $.05, 0.05, or 5.00
real_timeA boolean value (0 or 1).

Possible Errors:

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