hello,
Home Page
Overview
Error Handling
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)
Asset/
DESCRIPTION
This section of the API handles basic operations (list, details) on assets associated with an account. An asset is a product or service associated with an account, such as a server, a DNS zone, a domain name or an SSL certificate, to list a few.
These methods are used for gathering information about what assets a given account has. Methods for manipulating or gathering further information about an asset can be found in different API namespaces.
connections
URL:
https://api.liquidweb.com/bleed/Asset/connections
Description:
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| no_groups | A boolean value (0 or 1). Some operations can be made faster by not requesting the group data | |
| relationship_types | An array of a single word, consisting of only letters, digits, and underscores. | |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| details | An associative array of arbitrary keys and values. |
| groups | An associative array of arbitrary keys and values. |
| rows | An array of an associative array of arbitrary keys and values. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
details
URL:
https://api.liquidweb.com/bleed/Asset/details
Description:
This method can be used to gather information about a single account asset.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| alsowith | An array of One of: 'acronisBackingUp', 'ancestorServer', 'backupsAndStorage', 'businessEmailPricing', 'capabilities', 'categories', 'children', 'creation_date', 'description', 'diskDetails', 'distro', 'emailFriendlyName', 'featureDetails', 'finalizeDetails', 'generatedDomainDetails', 'hostedEmailPricing', 'hostedEmailUsage', 'hostingDetails', 'instance', 'loadbalancer', 'machine', 'managedType', 'mesDetails', 'monitorableServices', 'mrc', 'networkSummary', 'nocworxRemoteDetails', 'nocworxServiceDetails', 'objectStore', 'osFamily', 'parentDetails', 'powerStatus', 'price', 'primaryProductCategory', 'privateParent', 'product', 'productDisplayGroup', 'project', 'prometheusDetails', 'publicProductCategory', 'region', 'resourceState', 'servers', 'shortDescription', 'usageDetails', 'zone' | |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type | Notes |
|---|---|---|
| active | A boolean value (0 or 1). | |
| custom_name | A string of text, containing no newlines or other control characters and does not start with a space (Maximum length: 255) | * Optional |
| domain | Either: a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc); or a string of text, containing no newlines or other control characters. | |
| ip | An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) | * Optional |
| project_id | A positive integer value (i.e. 1 and up). | * Optional |
| project_name | A string permitting tabs, carriage returns and newlines | * Optional |
| region_id | A positive integer value (i.e. 1 and up). | |
| status | One of: 'Active', 'BucketPart', 'Disabled', 'New', 'Pending-Activation', 'Pending-Config', 'Pending-Payment', 'Pending-Termination', 'Terminated' | |
| type | A valid subaccnt type descriptor (i.e. DS.W1, GUARD, etc), at least 3 chars long. | |
| uniq_id | A six-character identifier, containing only capital letters and digits. | |
| username | Either: a subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).; or a fixed-length identifier, 6 characters in length, containing only capital letters and numbers. | * Optional |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
finalize
URL:
https://api.liquidweb.com/bleed/Asset/finalize
Description:
This method can be used to enable certain subaccounts that require additional configuration after purchase.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
| update_data | An associative array of arbitrary keys and values. |
Returns:
| Field | Type | Notes |
|---|---|---|
| active | A boolean value (0 or 1). | |
| custom_name | A string of text, containing no newlines or other control characters and does not start with a space (Maximum length: 255) | * Optional |
| domain | Either: a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc); or a string of text, containing no newlines or other control characters. | |
| ip | An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) | * Optional |
| product | An associative array of arbitrary keys and values. | |
| project_id | A positive integer value (i.e. 1 and up). | * Optional |
| project_name | A string permitting tabs, carriage returns and newlines | * Optional |
| region_id | A positive integer value (i.e. 1 and up). | |
| status | One of: 'Active', 'BucketPart', 'Disabled', 'New', 'Pending-Activation', 'Pending-Config', 'Pending-Payment', 'Pending-Termination', 'Terminated' | |
| type | A valid subaccnt type descriptor (i.e. DS.W1, GUARD, etc), at least 3 chars long. | |
| uniq_id | A six-character identifier, containing only capital letters and digits. | |
| username | Either: a subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).; or a fixed-length identifier, 6 characters in length, containing only capital letters and numbers. | * Optional |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
isValid
URL:
https://api.liquidweb.com/bleed/Asset/isValid
Description:
Takes arrays of both UNIQ_IDs and DOMAINS and returns a series of BOOLEANs indicating if those are valid assets for a given account
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| domain | An array of a string permitting tabs, carriage returns and newlines | * Required |
| uniq_id | An array of a string permitting tabs, carriage returns and newlines | * Required |
Returns:
| Field | Type | Notes | ||||
|---|---|---|---|---|---|---|
| domain | An array of associative arrays containing | * Optional | ||||
| ||||||
| uniq_id | An array of associative arrays containing | * Optional | ||||
| ||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
list
URL:
https://api.liquidweb.com/bleed/Asset/list
Description:
Get a list of servers, services, and devices on your account.
Valid options for category include:
Dedicated -- This includes dedicated and virtual servers as well as special dedicated items VirtualDedicated -- Legacy vps and provisioned servers StrictDedicated -- Dedicated servers SpecialDedicated -- This list includes network devices and load balancers Provisioned -- Products which are subject to automated provisioning, such as Storm LoadBalancer -- A hardware or software load balancer ObjectStorage -- An object storage account. SBS -- Products backed by our Storm Block Storage technology
Parameters:
| Parameter | Type | Notes | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| alsowith | An array of One of: 'acronisBackingUp', 'ancestorServer', 'backupsAndStorage', 'businessEmailPricing', 'capabilities', 'categories', 'children', 'creation_date', 'description', 'diskDetails', 'distro', 'emailFriendlyName', 'featureDetails', 'finalizeDetails', 'generatedDomainDetails', 'hostedEmailPricing', 'hostedEmailUsage', 'hostingDetails', 'instance', 'loadbalancer', 'machine', 'managedType', 'mesDetails', 'monitorableServices', 'mrc', 'networkSummary', 'nocworxRemoteDetails', 'nocworxServiceDetails', 'objectStore', 'osFamily', 'parentDetails', 'powerStatus', 'price', 'primaryProductCategory', 'privateParent', 'product', 'productDisplayGroup', 'project', 'prometheusDetails', 'publicProductCategory', 'region', 'resourceState', 'servers', 'shortDescription', 'usageDetails', 'zone' | |||||||||
| capability | A single word, consisting of only letters and digits. | |||||||||
| category | An array of a single word, consisting of only letters and digits. | |||||||||
| custom_name | One of the following: | |||||||||
| ||||||||||
| domain | Either: a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc); or a fragment of a valid domain name, suitable for partial domain searching | * Required if:
| ||||||||
| domain_match | A boolean value (0 or 1). Find all assets via partial domain match rather than exact match | |||||||||
| exclude_category | An array of a single word, consisting of only letters and digits. | |||||||||
| order_by | An associative array containing the fields: | |||||||||
| ||||||||||
| page_num | A positive integer value (i.e. 1 and up). | * Optional
| ||||||||
| page_size | A positive integer value (i.e. 1 and up). | * Optional
| ||||||||
| project_name | A string permitting tabs, carriage returns and newlines | |||||||||
| public_category | A single word, consisting of only letters and digits. | |||||||||
| status | A standardized search for a valid subaccnt status (New, Active, BucketPart, Disabled, Terminated, Pending-Termination, Pending-Activation, Pending-Payment, Pending-Config). | |||||||||
| type | Either: a valid subaccnt type descriptor (i.e. DS.W1, GUARD, etc), at least 3 chars long.; or An array of a valid subaccnt type descriptor (i.e. DS.W1, GUARD, etc), at least 3 chars long. | |||||||||
| uniq_id | An array of a six-character identifier, containing only capital letters and digits. | |||||||||
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
password
URL:
https://api.liquidweb.com/bleed/Asset/password
Description:
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| password | A string permitting tabs, carriage returns and newlines |
| username | A string permitting tabs, carriage returns and newlines |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
remove
URL:
https://api.liquidweb.com/bleed/Asset/remove
Description:
Request removal of this asset.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| cancellation_comment | A string permitting tabs, carriage returns and newlines | |
| cancellation_reason | A string permitting tabs, carriage returns and newlines | |
| cleanup_assets | A boolean value (0 or 1). If this is the last subaccount on the account that is not an SSL, Domain Registration or DNS Zone, disable auto-renew on all Domain Registrations and SSL certificates and remove all remaining DNS zones. | * Optional
|
| rating | One of: '0', '10', '5' Rating of customer's experience with Liquid Web. | |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| removal_requested | A six-character identifier, containing only capital letters and digits. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
startPciScan
URL:
https://api.liquidweb.com/bleed/Asset/startPciScan
Description:
Launch a PCI scan for a PCI service subaccnt. Results will be sent as PDF attachments to a Salesforce ticket.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| scan_started | A boolean value (0 or 1). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
update
URL:
https://api.liquidweb.com/bleed/Asset/update
Description:
Change the details of a subaccnt.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| custom_name | A string of text, containing no newlines or other control characters. | |
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | |
| features | An associative array of arbitrary keys and values. | |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type | Notes |
|---|---|---|
| accnt | A valid account number, up to 6 digits in length. | |
| active | A boolean value (0 or 1). | |
| capabilities | An associative array of arbitrary keys and values. | * Optional |
| categories | An array of a string. | * Optional |
| custom_name | A string of text, containing no newlines or other control characters and does not start with a space (Maximum length: 255) | * Optional |
| description | A string. | |
| domain | Either: a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc); or a string of text, containing no newlines or other control characters. | |
| features | An associative array of arbitrary keys and values. | * Optional |
| ip | An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) | * Optional |
| region_id | A positive integer value (i.e. 1 and up). | |
| type | A valid subaccnt type descriptor (i.e. DS.W1, GUARD, etc), at least 3 chars long. | |
| uniq_id | A six-character identifier, containing only capital letters and digits. | |
| username | Either: a subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).; or a fixed-length identifier, 6 characters in length, containing only capital letters and numbers. | * Optional |
| valid_source_hvs | An associative array of arbitrary keys and values. | * Optional |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
