Error Handling
Methods
- Account/
- Account/Auth/
- Account/Auth/TwoFactor/
- Account/BillingAddress/
- Account/ChangeOrder/Source/
- Account/ChatPassword/
- Account/Contact/
- Account/CreditCard/
- Account/Cycle/
- Account/Limits/
- Account/PasswordReset/
- Account/Paymethod/
- Account/SSH/Key/
- Account/Settings/
- Account/Subscriptions/
- Account/User/
- Account/User/StateData/
- Acronis/Backup/
- Asset/
- Asset/Connections/
- Asset/ControlPanel/Credentials/
- Asset/Measurements/
- Asset/Monitoring/
- Attribution/
- Basket/
- Basket/Domain/
- Basket/Item/
- Basket/Item/Config/
- Billing/
- Billing/Bill/
- Billing/Credit/
- Billing/CreditCard/Profile/
- Billing/Cycle/
- Billing/Invoice/
- Billing/Invoice/Preview/
- Billing/PayPal/Agreement/
- Billing/PayPal/Payment/
- Billing/Payment/
- Billing/Payment/Profile/
- BusinessEmail/Customer/
- BusinessEmail/Domain/
- Cloud/Backup/
- Cloud/Config/
- Cloud/IP/Pool/
- Cloud/Image/
- Cloud/Private/Parent/
- Cloud/Server/
- Cloud/Template/
- CloudSites/
- CloudSites/Usage/
- CodeGuard/User/
- Contact/
- Coupon/
- Coupon/Claim/
- Domain/
- Domain/Services/
- HostedEmail/Customer/
- HostedEmail/Domain/
- Licensing/
- Licensing/Cpanel/
- Licensing/Plesk/
- Market/Bundle/
- Market/Bundle/Package/
- Market/Cart/
- Market/Cart/Admin/Quote/
- Market/Cart/Discount/
- Market/Cart/Helpers/Configurator/
- Market/Cart/Item/
- Market/Package/
- Market/Package/Product/
- Market/Place/
- Meta/Timing/
- Migration/
- Migration/Account/
- Migration/Account/Server/
- Migration/Account/Server/Access/
- Migration/Destination/
- Monitoring/Bandwidth/
- Monitoring/Load/
- Monitoring/MWP/
- Monitoring/Services/
- Network/CDN/User/
- Network/CDN/Zone/
- Network/DNS/Domain/
- Network/DNS/Domain/Contact/
- Network/DNS/Domain/Nameserver/
- Network/DNS/Domain/Transfer/
- Network/DNS/Record/
- Network/DNS/Reverse/
- Network/DNS/Zone/
- Network/DNS/Zone/History/
- Network/Firewall/
- Network/Firewall/Ruleset/
- Network/IP/
- Network/LoadBalancer/
- Network/Pool/
- Network/Private/
- Network/Region/
- Network/SSHKey/
- Network/Util/
- Network/Zone/
- Notifications/
- OneTimeSecret/
- Order/AddOn/
- Product/
- Product/Addon/
- Product/Marketplace/
- Product/Series/
- Project/
- SSL/Certificate/
- Salesforce/Account/InterWorx/
- Salesforce/Chat/Auth/
- Salesforce/User/
- Server/
- Server/Auth/
- Server/Power/
- Server/VirtualDomain/
- Server/WHM/AccessHash/
- Server/WHM/DNS/
- Server/WHM/Firewall/
- Signup/Basic/
- Storage/Block/Cluster/
- Storage/Block/Volume/
- Storage/ObjectStore/
- Support/Alert/
- Support/Request/
- Support/Request/Attachment/
- Support/SystemStatus/
- Support/Ticket/Auth/
- Tags/Product/
- UserTask/
- Utilities/Info/
- VIP/
- VMware/vCloud/vDC/
- VPN/
- VPN/User/
- WWW/Cart/
- WordPress/Domain/
API Documentation (API Version bleed)
Account/
DESCRIPTION
This section contains methods to order an account (or order new services for an existing account), and to get details about an account.
adCampaigns
URL:
https://api.liquidweb.com/bleed/Account/adCampaigns
Description:
Ad campaign information for a given account.
Parameters:
No Values Defined
Returns:
Field | Type | |||||||
---|---|---|---|---|---|---|---|---|
campaigns | An array of associative arrays containing | |||||||
|
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
details
URL:
https://api.liquidweb.com/bleed/Account/details
Description:
Returns account details.
Parameters:
Parameter | Type |
---|---|
alsowith | An array of One of: 'accountContact', 'businessUnit', 'customerLifecycle', 'highlights', 'managementPortal', 'mrc', 'referAFriend' |
Returns:
Field | Type |
---|---|
accnt | A valid account number, up to 6 digits in length. |
account_status | A single word, consisting of only letters and digits. |
level | A single word, consisting of only letters and digits. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
getVisitCycles
URL:
https://api.liquidweb.com/bleed/Account/getVisitCycles
Description:
Returns the date ranges for the current, previous, and previous previous visit cycles.
Note: This is calculated based on current visit billing date. If the billing date has been changed in the last three months, this may be inaccurate.
Parameters:
No Values Defined
Returns:
Field | Type | |||||||
---|---|---|---|---|---|---|---|---|
cycles | An array of associative arrays containing | |||||||
|
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
highlights
URL:
https://api.liquidweb.com/bleed/Account/highlights
Description:
Retrieve Highlights from account
Parameters:
No Values Defined
Returns:
Field | Type | |||||
---|---|---|---|---|---|---|
highlights | An array of associative arrays containing | |||||
|
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
invoicesAndPaymentsTimeline
URL:
https://api.liquidweb.com/bleed/Account/invoicesAndPaymentsTimeline
Description:
List of invoices and payments for the account sorted by created date descending (i.e., most recent first)
Parameters:
Parameter | Type | Notes |
---|---|---|
begin_date | A valid date in YYYY-MM-DD format. | |
end_date | A valid date in YYYY-MM-DD format. | |
invoice_id | A valid id number (a positive integer). | |
page_num | A positive integer value (i.e. 1 and up). | * Optional
|
page_size | A positive integer value (i.e. 1 and up). | * Optional
|
title | One of: 'invoice', 'payment' |
Returns:
Field | Type | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
item_count | A non-negative integer value (i.e. 0 and up). | ||||||||||||||||||||||
item_total | A non-negative integer value (i.e. 0 and up). | ||||||||||||||||||||||
items | An array of associative arrays containing | ||||||||||||||||||||||
| |||||||||||||||||||||||
page_num | A positive integer value (i.e. 1 and up). | ||||||||||||||||||||||
page_size | A positive integer value (i.e. 1 and up). | ||||||||||||||||||||||
page_total | A positive integer value (i.e. 1 and up). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
level
URL:
https://api.liquidweb.com/bleed/Account/level
Description:
Returns the account's level.
Parameters:
No Values Defined
Returns:
Field | Type |
---|---|
accnt | A valid account number, up to 6 digits in length. |
level | A single word, consisting of only letters and digits. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
order
URL:
https://api.liquidweb.com/bleed/Account/order
Description:
Place an order for services creating a new account.
Parameters:
Parameter | Type | Notes | ||||||
---|---|---|---|---|---|---|---|---|
address | A valid street address, up to 150 characters in length. | * Required | ||||||
address2 | A valid street address, up to 150 characters in length. | |||||||
attribution | An array of associative arrays containing | |||||||
| ||||||||
cardCode | The cvv code of a credit card, consisting of a number at least 3 digits and up to 4 digits in length (i.e. 1234, 010, etc). | |||||||
cart | An associative array of arbitrary keys and values. | * Required | ||||||
city | A valid city name. | * Required | ||||||
cjaid | A string of text, containing no newlines or other control characters. | |||||||
cjsid | A string of text, containing no newlines or other control characters. | |||||||
company | A valid company name, up to 100 characters in length. | |||||||
country | A valid ISO country code. | * Required | ||||||
coupon | A 6 to 40 character coupon code | |||||||
customer_uuid | A valid UUID (Universally Unique IDentifier). | * Required if:
| ||||||
domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | * Required | ||||||
A valid email address. | * Required | |||||||
fax | A valid phone number. | |||||||
fname | A valid name, up to 100 characters in length. | |||||||
is_san_order | A boolean value (0 or 1). | |||||||
is_shared_order | A boolean value (0 or 1). | |||||||
lname | A valid name, up to 100 characters in length. | * Required | ||||||
opportunity_id | A string of text, containing no newlines or other control characters. | |||||||
password | A password of at least 6 characters and up to 30 characters in length, may contain spaces | * Required | ||||||
passwordVerify | A password of at least 6 characters and up to 30 characters in length, may contain spaces | * Required | ||||||
paymentInterval | A single word, consisting of only letters and digits. | * Required | ||||||
paymentMethod | A single word, consisting of only letters, digits, and underscores. | * Required | ||||||
phone | A valid phone number. | * Required | ||||||
phone_check | A positive integer value (i.e. 1 and up). | |||||||
phone_code | A non-negative integer value (i.e. 0 and up). | |||||||
quoteName | A single word, consisting of only letters, digits, hyphens, and underscores. | |||||||
referredBy | A string. | |||||||
referredByType | A string. | |||||||
sid | A string of text, containing no newlines or other control characters. | |||||||
state | A valid state or province. | |||||||
tax_exempt | A boolean value (0 or 1). | |||||||
tax_exempt_id | A string of text, containing no newlines or other control characters. | * Required if:
| ||||||
tax_exempt_reason | A string of text, containing no newlines or other control characters. | * Required if:
| ||||||
tax_id | A string of text, containing no newlines or other control characters. | * Required if:
| ||||||
traits | An array of arbitrary values. | |||||||
userComments | A string permitting tabs, carriage returns and newlines | |||||||
username | A subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols). | |||||||
validated | A boolean value (0 or 1). | |||||||
zip | A valid postal code. |
Returns:
Field | Type | Notes |
---|---|---|
accnt | A valid account number, up to 6 digits in length. | |
order_id | A positive integer value (i.e. 1 and up). | |
order_type | A string of text, containing no newlines or other control characters. | * Optional |
pending_configs | A non-negative integer value (i.e. 0 and up). | |
support_passphrase | A string permitting tabs, carriage returns and newlines |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
recoverUsername
URL:
https://api.liquidweb.com/bleed/Account/recoverUsername
Description:
Expects either account number or email address. If valid input is given, sends account info email to email address on file.
Parameters:
Parameter | Type | Notes |
---|---|---|
account | A valid account number, up to 6 digits in length. | * Required if:
|
A valid email address. | * Required if:
|
Returns:
Field | Type |
---|---|
submitted | A boolean value (0 or 1). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
signup
URL:
https://api.liquidweb.com/bleed/Account/signup
Description:
New Account Signup handling
Parameters:
Parameter | Type | Notes | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
address | An associative array containing the fields: | * Required | |||||||||||||||||||||
| |||||||||||||||||||||||
billing | An associative array containing the fields: | ||||||||||||||||||||||
| |||||||||||||||||||||||
contact | An associative array containing the fields: | * Required | |||||||||||||||||||||
| |||||||||||||||||||||||
extra | An associative array containing the fields: | ||||||||||||||||||||||
| |||||||||||||||||||||||
identity | An associative array containing the fields: | * Required | |||||||||||||||||||||
|
Returns:
Field | Type |
---|---|
accnt | A valid account number, up to 6 digits in length. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
supportSummary
URL:
https://api.liquidweb.com/bleed/Account/supportSummary
Description:
Information related to support for a given account
Parameters:
No Values Defined
Returns:
Field | Type | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
one_time_secrets | An associative array containing the fields: | ||||||||||||||||
| |||||||||||||||||
tickets | An associative array containing the fields: | ||||||||||||||||
|
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
upgrade
URL:
https://api.liquidweb.com/bleed/Account/upgrade
Description:
Place an order for services adding services to an existing account.
Parameters:
Parameter | Type | Notes | ||||||
---|---|---|---|---|---|---|---|---|
attribution | An array of associative arrays containing | |||||||
| ||||||||
cardCode | The cvv code of a credit card, consisting of a number at least 3 digits and up to 4 digits in length (i.e. 1234, 010, etc). | |||||||
cart | An associative array of arbitrary keys and values. | * Required | ||||||
cjaid | A string of text, containing no newlines or other control characters. | |||||||
cjsid | A string of text, containing no newlines or other control characters. | |||||||
coupon | A 6 to 40 character coupon code | |||||||
customer_uuid | A valid UUID (Universally Unique IDentifier). | * Required if:
| ||||||
domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | * Required | ||||||
is_san_order | A boolean value (0 or 1). | |||||||
is_shared_order | A boolean value (0 or 1). | |||||||
opportunity_id | A string of text, containing no newlines or other control characters. | |||||||
paymentMethod | A single word, consisting of only letters, digits, and underscores. | |||||||
quoteName | A single word, consisting of only letters, digits, hyphens, and underscores. | |||||||
referredBy | A string. | |||||||
referredByType | A string. | |||||||
sid | A string of text, containing no newlines or other control characters. | |||||||
traits | An array of arbitrary values. | |||||||
userComments | A string permitting tabs, carriage returns and newlines |
Returns:
Field | Type | Notes |
---|---|---|
accnt | A valid account number, up to 6 digits in length. | |
order_id | A positive integer value (i.e. 1 and up). | |
order_type | A string of text, containing no newlines or other control characters. | * Optional |
pending_configs | A non-negative integer value (i.e. 0 and up). | |
support_passphrase | A string permitting tabs, carriage returns and newlines | * Optional |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types