Overview
Error Handling

Methods

API Documentation (API Version bleed)

Market/Cart/Helpers/Configurator/

DESCRIPTION

This section of the API is to provide helper methods for special configurator UIs built for specific Liquid Web server products

add

URL:

https://api.liquidweb.com/bleed/Market/Cart/Helpers/Configurator/add

Description:

Add a server and desired configuration to the cart. If a cart uuid is not provided a new cart will be generated automatically.

Zone is irrelevant to the Bare Metal products in addition to some other parameters.

Parameters:

ParameterTypeNotes
backupsAn associative array containing the fields:* Optional
  • Defaults to: HASH(0x5d7b250)
 
daysA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 3
nameOne of: 'none', 'per_gb'* Required
block_storageAn associative array containing the fields:* Optional
  • Defaults to: HASH(0x5d7b5b0)
 
gbA positive integer value (i.e. 1 and up).* Required if:
  • name is set to 'per_gb'
nameOne of: 'none', 'per_gb'* Required
cart_item_uuidA valid UUID (Universally Unique IDentifier).
cart_uuidA valid UUID (Universally Unique IDentifier).
config_idA positive integer value (i.e. 1 and up).* Required
cpanel_licenseA product option value.
cycleA valid billing cycle (monthly, quarterly, biannually, yearly, or biennially).* Optional
  • Defaults to: monthly
ddosOne of: 'Advanced', 'Standard'* Optional
  • Defaults to: Standard
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
extra_ipA non-negative integer value (i.e. 0 and up).* Optional
  • Defaults to: 0
mssqlA product option value.
package_codeA valid market package code, beginning with "PKG-" and the rest beging at least 3 chars long, including at least one letter.* Required if:
  • product_code is not given
package_version_idA valid id number (a positive integer).* Required if:
  • product_code is not given
plesk_editionA product option value.
product_codeA valid product code, at least 3 chars long, including at least one letter.* Required if:
  • package_code is not given
quantityA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
region_idA positive integer value (i.e. 1 and up).* Required
templateA product option value.* Required
use_ipv6A boolean value (0 or 1).* Optional
  • Defaults to: 0
win_avA product option value.
zone_idA positive integer value (i.e. 1 and up).

Returns:

FieldType
cart_uuidA valid UUID (Universally Unique IDentifier).

Possible Errors:

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

details

URL:

https://api.liquidweb.com/bleed/Market/Cart/Helpers/Configurator/details

Description:

Returns details to add a Cloud VPS, Bare Metal Cloud, Bare Metal, or Bare Metal GPU product (or package) to the cart.

For the Cloud products, regions can have more than one zone and the latest zone in the region will be used unless otherwise specified in parameters.

Zone is irrelevant to the Bare Metal products.

Parameters:

ParameterTypeNotes
package_codeA valid market package code, beginning with "PKG-" and the rest beging at least 3 chars long, including at least one letter.* Required if:
  • product_code is not given
product_codeA valid product code, at least 3 chars long, including at least one letter.* Required if:
  • package_code is not given
region_idA positive integer value (i.e. 1 and up).
zone_idA positive integer value (i.e. 1 and up).

Returns:

FieldTypeNotes
backupsAn array of associative arrays containing
 
nameOne of: 'none', 'per_gb'
block_storageAn array of associative arrays containing
 
nameOne of: 'none', 'per_gb'
control_panelsAn array of associative arrays containing
 
included_optionsAn array of associative arrays containing
 
keyA product option name.
nameA string of text, containing no newlines or other control characters.
valuesAn array of associative arrays containing
 
descriptionA string of text, containing no newlines or other control characters.
valueA product option value.
typeA string consisting of only letters, digits, hyphens, spaces, and underscores.
cyclesAn array of associative arrays containing
 
cycleA valid billing cycle (monthly, quarterly, biannually, yearly, or biennially).
discount_percentA floating-point value.* Optional
discount_repetitionsA floating-point value.* Optional
discountsAn array of associative arrays containing
 
amountA floating-point value.
month_repetitionsA floating-point value.* Optional
package_product_option_idA valid id number (a positive integer).* Optional
monthsA positive integer value (i.e. 1 and up).
ddosAn array of associative arrays containing
 
nameOne of: 'Advanced', 'Standard'
extra_ipAn associative array containing the fields:
 
maxA non-negative integer value (i.e. 0 and up).
minA non-negative integer value (i.e. 0 and up).
hardwareAn array of associative arrays containing
 
categoryA string.
configsAn array of associative arrays containing
 
coresA positive integer value (i.e. 1 and up).* Required if:
  • category is set to 'bare-metal'
cpu_coresA positive integer value (i.e. 1 and up).* Required if:
  • category is set to 'bare-metal'
cpu_countA positive integer value (i.e. 1 and up).* Required if:
  • category is set to 'bare-metal'
cpu_hyperthreadingA boolean value (0 or 1).* Required if:
  • category is set to 'bare-metal'
cpu_modelA string.* Required if:
  • category is set to 'bare-metal'
cpu_speedA positive integer value (i.e. 1 and up).* Required if:
  • category is set to 'bare-metal'
descriptionA string of text, containing no newlines or other control characters.
diskA positive integer value (i.e. 1 and up).* Optional
disk_typeA string permitting tabs, carriage returns and newlines* Required if:
  • category is set to 'bare-metal'
gpu_countA positive integer value (i.e. 1 and up).* Required if:
  • category is set to 'bare-metal-gpu'
gpu_nameA string of text, containing no newlines or other control characters.* Required if:
  • category is set to 'bare-metal-gpu'
idA positive integer value (i.e. 1 and up).
included_optionsAn array of associative arrays containing
 
keyA product option name.
nameA string of text, containing no newlines or other control characters.
valuesAn array of associative arrays containing
 
descriptionA string of text, containing no newlines or other control characters.
valueA product option value.
link_speedA positive integer value (i.e. 1 and up).* Optional
memoryA positive integer value (i.e. 1 and up).* Optional
raid_levelAn integer value.* Required if:
  • category is set to 'bare-metal'
vcpuA positive integer value (i.e. 1 and up).* Optional
descriptionA string of text, containing no newlines or other control characters.
managementAn array of One of: 'Core-Managed', 'Fully-Managed', 'Self-Managed'
osAn array of associative arrays containing
 
bitA non-negative integer value (i.e. 0 and up).
nameA string consisting of only letters, digits, hyphens, spaces, and underscores.
typeOne of: 'Linux', 'Windows'
versionA string of text, containing no newlines or other control characters.
package_version_idA valid id number (a positive integer).* Optional
regionsAn array of associative arrays containing
 
backupsAn array of associative arrays containing
 
defaultA boolean value (0 or 1).
nameOne of: 'none', 'per_gb'
per_gb_priceAn array of associative arrays containing
 
amountA monetary value, such as -$.05, 0.05, or -5.00
unitOne of: 'hour', 'month'
block_storageAn array of associative arrays containing
 
defaultA boolean value (0 or 1).
nameOne of: 'none', 'per_gb'
per_gb_priceAn array of associative arrays containing
 
amountA monetary value, such as -$.05, 0.05, or -5.00
unitOne of: 'hour', 'month'
configsAn array of associative arrays containing
 
bandwidthA positive integer value (i.e. 1 and up).
defaultA boolean value (0 or 1).
display_orderA non-negative integer value (i.e. 0 and up).
idA positive integer value (i.e. 1 and up).
included_optionsAn array of associative arrays containing
 
display_orderA non-negative integer value (i.e. 0 and up).
keyA product option name.
nameA string of text, containing no newlines or other control characters.
valuesAn array of associative arrays containing
 
defaultA boolean value (0 or 1).
descriptionA string of text, containing no newlines or other control characters.
display_orderA non-negative integer value (i.e. 0 and up).
priceAn array of associative arrays containing
 
amountA monetary value, such as -$.05, 0.05, or -5.00
unitOne of: 'hour', 'month'
valueA product option value.
package_product_option_idA valid id number (a positive integer).* Optional
priceAn array of associative arrays containing
 
amountA monetary value, such as -$.05, 0.05, or -5.00
unitOne of: 'hour', 'month'
ddosAn array of associative arrays containing
 
defaultA boolean value (0 or 1).
nameOne of: 'Advanced', 'Standard'
priceAn array of associative arrays containing
 
amountA monetary value, such as -$.05, 0.05, or -5.00
unitOne of: 'hour', 'month'
extra_ipAn associative array containing the fields:
 
maxA non-negative integer value (i.e. 0 and up).
minA non-negative integer value (i.e. 0 and up).
per_ip_priceAn array of associative arrays containing
 
amountA monetary value, such as -$.05, 0.05, or -5.00
unitOne of: 'hour', 'month'
idA positive integer value (i.e. 1 and up).
managementAn array of associative arrays containing
 
defaultA boolean value (0 or 1).
display_orderA non-negative integer value (i.e. 0 and up).
nameOne of: 'Core-Managed', 'Fully-Managed', 'Self-Managed'
osAn array of associative arrays containing
 
bitA non-negative integer value (i.e. 0 and up).
control_panelsAn array of associative arrays containing
 
defaultA boolean value (0 or 1).
display_orderA non-negative integer value (i.e. 0 and up).
included_optionsAn array of associative arrays containing
 
display_orderA non-negative integer value (i.e. 0 and up).
keyA product option name.
nameA string of text, containing no newlines or other control characters.
valuesAn array of associative arrays containing
 
defaultA boolean value (0 or 1).
descriptionA string of text, containing no newlines or other control characters.
display_orderA non-negative integer value (i.e. 0 and up).
priceAn array of associative arrays containing
 
amountA monetary value, such as -$.05, 0.05, or -5.00
unitOne of: 'hour', 'month'
valueA product option value.
nameA string consisting of only letters, digits, hyphens, spaces, and underscores.
priceAn array of associative arrays containing
 
amountA monetary value, such as -$.05, 0.05, or -5.00
unitOne of: 'hour', 'month'
templateA product option value.
defaultA boolean value (0 or 1).
display_orderA non-negative integer value (i.e. 0 and up).
nameA string consisting of only letters, digits, hyphens, spaces, and underscores.
priceAn array of associative arrays containing
 
amountA monetary value, such as -$.05, 0.05, or -5.00
unitOne of: 'hour', 'month'
typeOne of: 'Linux', 'Windows'
versionA string of text, containing no newlines or other control characters.
priceAn array of associative arrays containing
 
amountA monetary value, such as -$.05, 0.05, or -5.00
unitOne of: 'hour', 'month'
nameOne of: 'ams', 'lan', 'phx'
other_options_pricingAn array of associative arrays containing
 
amountA monetary value, such as -$.05, 0.05, or -5.00
unitOne of: 'hour', 'month'
zoneA single letter.
zone_idA positive integer value (i.e. 1 and up).

Possible Errors:

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