Overview
Error Handling

Methods

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.

details

URL:

https://api.liquidweb.com/bleed/Asset/details

Description:

This method can be used to gather information about a single account asset.

Parameters:

ParameterTypeNotes
alsowithAn array of One of: 'backupsAndStorage', 'businessEmailPricing', 'capabilities', 'categories', 'children', 'creation_date', 'description', 'diskDetails', 'distro', 'emailFriendlyName', 'featureDetails', 'finalizeDetails', 'hostedEmailPricing', 'hostedEmailUsage', 'hostingDetails', 'instance', 'loadbalancer', 'managedType', 'mesDetails', 'monitorableServices', 'mrc', 'networkSummary', 'nocworxRemoteDetails', 'nocworxServiceDetails', 'objectStore', 'osFamily', 'parentDetails', 'powerStatus', 'price', 'primaryProductCategory', 'privateParent', 'product', 'project', 'prometheusDetails', 'publicProductCategory', 'resourceState', 'servers', 'shortDescription', 'usageDetails', 'zone'
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldTypeNotes
activeA boolean value (0 or 1).
domainEither: 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.
ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)* Optional
project_idA positive integer value (i.e. 1 and up).* Optional
project_nameA string permitting tabs, carriage returns and newlines* Optional
region_idA positive integer value (i.e. 1 and up).
statusOne of: 'Active', 'Disabled', 'New', 'Pending-Activation', 'Pending-Payment', 'Pending-Termination', 'Terminated'
typeA valid subaccnt type descriptor (i.e. DS.W1, GUARD, etc), at least 3 chars long.
uniq_idA six-character identifier, containing only capital letters and digits.
usernameEither: 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:

ParameterTypeNotes
uniq_idA six-character identifier, containing only capital letters and digits.* Required
update_dataAn associative array of arbitrary keys and values.

Returns:

FieldTypeNotes
activeA boolean value (0 or 1).
domainEither: 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.
ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)* Optional
productAn associative array of arbitrary keys and values.
project_idA positive integer value (i.e. 1 and up).* Optional
project_nameA string permitting tabs, carriage returns and newlines* Optional
region_idA positive integer value (i.e. 1 and up).
statusOne of: 'Active', 'Disabled', 'New', 'Pending-Activation', 'Pending-Payment', 'Pending-Termination', 'Terminated'
typeA valid subaccnt type descriptor (i.e. DS.W1, GUARD, etc), at least 3 chars long.
uniq_idA six-character identifier, containing only capital letters and digits.
usernameEither: 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:

ParameterTypeNotes
domainAn array of a string permitting tabs, carriage returns and newlines* Required
uniq_idAn array of a string permitting tabs, carriage returns and newlines* Required

Returns:

FieldTypeNotes
domainAn array of associative arrays containing * Optional
 
idA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
validA boolean value (0 or 1).
uniq_idAn array of associative arrays containing * Optional
 
idA six-character identifier, containing only capital letters and digits.
validA 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/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:

ParameterTypeNotes
alsowithAn array of One of: 'backupsAndStorage', 'businessEmailPricing', 'capabilities', 'categories', 'children', 'creation_date', 'description', 'diskDetails', 'distro', 'emailFriendlyName', 'featureDetails', 'finalizeDetails', 'hostedEmailPricing', 'hostedEmailUsage', 'hostingDetails', 'instance', 'loadbalancer', 'managedType', 'mesDetails', 'monitorableServices', 'mrc', 'networkSummary', 'nocworxRemoteDetails', 'nocworxServiceDetails', 'objectStore', 'osFamily', 'parentDetails', 'powerStatus', 'price', 'primaryProductCategory', 'privateParent', 'product', 'project', 'prometheusDetails', 'publicProductCategory', 'resourceState', 'servers', 'shortDescription', 'usageDetails', 'zone'
capabilityA single word, consisting of only letters and digits.
categoryAn array of a single word, consisting of only letters and digits.
domainEither: 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 is set to '1'
domain_match

A boolean value (0 or 1).

Find all assets via partial domain match rather than exact match

exclude_categoryAn array of a single word, consisting of only letters and digits.
order_byAn associative array containing the fields:
 
fieldOne of: 'domain', 'project_name', 'type'* 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
project_nameA string permitting tabs, carriage returns and newlines
public_categoryA single word, consisting of only letters and digits.
statusA standardized search for a valid subaccnt status (New, Active, BucketPart, Disabled, Terminated, Pending-Termination, Pending-Activation, Pending-Payment).
typeEither: 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_idAn array of a 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
 
activeA boolean value (0 or 1).
domainEither: 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.
ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)* Optional
project_idA positive integer value (i.e. 1 and up).* Optional
project_nameA string permitting tabs, carriage returns and newlines* Optional
region_idA positive integer value (i.e. 1 and up).
statusOne of: 'Active', 'Disabled', 'New', 'Pending-Activation', 'Pending-Payment', 'Pending-Termination', 'Terminated'
typeA valid subaccnt type descriptor (i.e. DS.W1, GUARD, etc), at least 3 chars long.
uniq_idA six-character identifier, containing only capital letters and digits.
usernameEither: 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
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

remove

URL:

https://api.liquidweb.com/bleed/Asset/remove

Description:

Request removal of this asset.

Parameters:

ParameterTypeNotes
cancellation_commentA string permitting tabs, carriage returns and newlines
cancellation_reasonA 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
  • Defaults to: 0
rating

One of: '0', '10', '5'

Rating of customer's experience with Liquid Web.

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

Returns:

FieldType
removal_requestedA six-character identifier, containing only capital letters and digits.

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:

ParameterTypeNotes
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
featuresAn associative array of arbitrary keys and values.
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.
activeA boolean value (0 or 1).
capabilitiesAn associative array of arbitrary keys and values.* Optional
categoriesAn array of a string.* Optional
descriptionA string.
domainEither: 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.
featuresAn associative array of arbitrary keys and values.* Optional
ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)* Optional
region_idA positive integer value (i.e. 1 and up).
typeA valid subaccnt type descriptor (i.e. DS.W1, GUARD, etc), at least 3 chars long.
uniq_idA six-character identifier, containing only capital letters and digits.
usernameEither: 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_hvsAn associative array of arbitrary keys and values.* Optional

Possible Errors:

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