Overview
Error Handling

Methods

API Documentation (API Version bleed)

HostedEmail/Domain/

archiveSsoUrl

URL:

https://api.liquidweb.com/bleed/HostedEmail/Domain/archiveSsoUrl

Description:

Parameters:

ParameterTypeNotes
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Required

Returns:

FieldType
sso_urlA string of text, containing no newlines or other control characters.

Possible Errors:

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

create

URL:

https://api.liquidweb.com/bleed/HostedEmail/Domain/create

Description:

Parameters:

ParameterTypeNotes
archiveA boolean value (0 or 1).
dns_recordsA boolean value (0 or 1).
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Required
exchange_quotaA non-negative integer value (i.e. 0 and up).
rsemail_quotaA non-negative integer value (i.e. 0 and up).
rseplusA boolean value (0 or 1).
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
accntA valid account number, up to 6 digits in length.
archiveA boolean value (0 or 1).
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
customer_idA positive integer value (i.e. 1 and up).
domainA valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters)
exchange_quotaA non-negative integer value (i.e. 0 and up).
exchange_usageA non-negative integer value (i.e. 0 and up).
idA valid id number (a positive integer).
rsemail_quotaA non-negative integer value (i.e. 0 and up).
rsemail_usageA non-negative integer value (i.e. 0 and up).
rseplusA boolean value (0 or 1).
statusA single word, consisting of only letters and digits.
uniq_idA six-character identifier, containing only capital letters and digits.
updated_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.

Possible Errors:

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

delete

URL:

https://api.liquidweb.com/bleed/HostedEmail/Domain/delete

Description:

Parameters:

ParameterTypeNotes
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Required

Returns:

FieldType
accntA valid account number, up to 6 digits in length.
archiveA boolean value (0 or 1).
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
customer_idA positive integer value (i.e. 1 and up).
domainA valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters)
exchange_quotaA non-negative integer value (i.e. 0 and up).
exchange_usageA non-negative integer value (i.e. 0 and up).
idA valid id number (a positive integer).
rsemail_quotaA non-negative integer value (i.e. 0 and up).
rsemail_usageA non-negative integer value (i.e. 0 and up).
rseplusA boolean value (0 or 1).
statusA single word, consisting of only letters and digits.
uniq_idA six-character identifier, containing only capital letters and digits.
updated_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.

Possible Errors:

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

details

URL:

https://api.liquidweb.com/bleed/HostedEmail/Domain/details

Description:

Parameters:

ParameterTypeNotes
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Required

Returns:

FieldType
accntA valid account number, up to 6 digits in length.
archiveA boolean value (0 or 1).
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
customer_idA positive integer value (i.e. 1 and up).
domainA valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters)
exchange_quotaA non-negative integer value (i.e. 0 and up).
exchange_usageA non-negative integer value (i.e. 0 and up).
idA valid id number (a positive integer).
rsemail_quotaA non-negative integer value (i.e. 0 and up).
rsemail_usageA non-negative integer value (i.e. 0 and up).
rseplusA boolean value (0 or 1).
statusA single word, consisting of only letters and digits.
uniq_idA six-character identifier, containing only capital letters and digits.
updated_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.

Possible Errors:

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

list

URL:

https://api.liquidweb.com/bleed/HostedEmail/Domain/list

Description:

Parameters:

ParameterTypeNotes
order_byAn associative array containing the fields:
 
fieldOne of: 'created_date', 'domain', 'id', 'updated_date'* Optional
  • Defaults to: domain
sortOne of: 'asc', 'desc'* Optional
  • Defaults to: asc
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
uniq_idA six-character identifier, containing only capital letters and digits.* Required

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
 
accntA valid account number, up to 6 digits in length.
archiveA boolean value (0 or 1).
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
customer_idA positive integer value (i.e. 1 and up).
domainA valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters)
exchange_quotaA non-negative integer value (i.e. 0 and up).
exchange_usageA non-negative integer value (i.e. 0 and up).
idA valid id number (a positive integer).
rsemail_quotaA non-negative integer value (i.e. 0 and up).
rsemail_usageA non-negative integer value (i.e. 0 and up).
rseplusA boolean value (0 or 1).
statusA single word, consisting of only letters and digits.
uniq_idA six-character identifier, containing only capital letters and digits.
updated_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
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.liquidweb.com/bleed/HostedEmail/Domain/update

Description:

Parameters:

ParameterTypeNotes
archiveA boolean value (0 or 1).
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Required
exchange_quotaA non-negative integer value (i.e. 0 and up).
rsemail_quotaA non-negative integer value (i.e. 0 and up).
rseplusA boolean value (0 or 1).

Returns:

FieldType
accntA valid account number, up to 6 digits in length.
archiveA boolean value (0 or 1).
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
customer_idA positive integer value (i.e. 1 and up).
domainA valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters)
exchange_quotaA non-negative integer value (i.e. 0 and up).
exchange_usageA non-negative integer value (i.e. 0 and up).
idA valid id number (a positive integer).
rsemail_quotaA non-negative integer value (i.e. 0 and up).
rsemail_usageA non-negative integer value (i.e. 0 and up).
rseplusA boolean value (0 or 1).
statusA single word, consisting of only letters and digits.
uniq_idA six-character identifier, containing only capital letters and digits.
updated_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.

Possible Errors:

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