Liquid Web API (v2)

Introduction

The official Liquid Web API.

Welcome to the Liquid Web API documentation. Our API offers a versatile set of options for managing Liquid Web services, such as Cloud VPS, Cloud Metal/Dedicated, Bare Metal, Object and Block Storage, DNS zones, and virtual IP addresses. To begin, you'll require a my.liquidweb.com API user for authentication and access to this API interface. If you haven't set up one yet, you can find clear instructions on creating API users here: Creating a Liquid Web Cloud API Token.

For added flexibility, we also provide additional API client libraries and the Liquid Web CLI on our Github page: Liquid Web on Github.

Feel free to explore the possibilities our API offers, and don't hesitate to reach out with any questions or feedback you may have. We're here to assist you on your technical journey.

DateTime

All DateTime fields are in EST/EDT unless indicated otherwise in the method's description.

Authentication

BearerAuth

Authorization header using the Bearer scheme.

Security Scheme Type: HTTP
HTTP Authorization Scheme: bearer

HTTPBasicAuth

Basic HTTP Authentication using a username along with a password or temporary authentication token.

Security Scheme Type: HTTP
HTTP Authorization Scheme: basic

Authentication Tokens

Using the account/auth/token method, it is possible to receive a temporary authentication token. While this token remains alive, it can be used in place of a password for HTTP Basic authentication for API requests. The lifetime of each token can be specified on creation, up to a maximum of twelve hours.

Two-Factor Authentication

API method calls authenticate using the credentials of a normal user account. If the user in question has enabled 2FA, each API call must be authenticated using a 2FA passcode. Each 2FA passcode is valid for thirty seconds, and during that time, it is the only passcode that is valid.

The trick is that, for important security reasons, each passcode can be used a maximum of one time. This necessarily means that API calls using a 2FA passcode can be made a maximum of once every thirty seconds.

The workaround here is to use the account/auth/token method to exchange a username + password + passcode combination for a username + token. This token will allow the use of API calls without the need to submit further 2FA passcodes. Recall that an authentication token lasts, at a maximum, twelve hours, after which time a new 2FA passcode would be needed to request a new token.

While this could be done programmatically, such a practice would negate the security benefits of 2FA (namely => the air - gap between TOTP generator and login prompt). As a result, we suggest against the enabling of 2FA for user accounts which will be used to perform API requests.

Errors

If the response code is 200, that means we successfully processed the request. Otherwise, the appropriate apache response code will be issued. The response will either be in the format described by the method's documentation, if no error occurred, or in the following format if an exception was raised:

{
    "error_class": "ExceptionType",
    "error_message": "The error message", 
    "extra_key": "extra_value"
}

Each error will have at least an 'error_class' and 'error_message' returned. Depending on the error type, additional information might be passed back to help narrow down the cause of the problem.

Parameter Encoding

Currently, the API supports the following encoding formats:

  • JSON
  • YAML

If your desired encoding is not supported, feel free to request it. If it's reasonable to implement, we'll do our best to accommodate the request.

You can specify an encoding by the file extension of the API URL. If none is specified, the default (JSON) will be used.

For example:

Account

This section contains methods to order an account (or order new services for an existing account), and to get details about an account.

account/details

Returns account details.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
alsowith
Array of any
Items Enum: "customerLifecycle" "businessUnit" "mrc" "highlights" "managementPortal" "referAFriend" "accountContact"
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "accnt": 0,
  • "account_status": "string",
  • "level": "string"
}

account/invoicesandpaymentstimeline

List of invoices and payments for the account sorted by created date descending (i.e., most recent first)

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
page_size
integer (POSITIVE_INT) ^[1-9]\d*\z
Default: 25
Example: page_size=80

A positive integer value (i.e. 1 and up).

end_date
string <date> (DATE_VALID)
Example: end_date=2012-04-23

A valid date in YYYY-MM-DD format.

begin_date
string <date> (DATE_VALID)
Example: begin_date=2012-04-23

A valid date in YYYY-MM-DD format.

page_num
integer (POSITIVE_INT) ^[1-9]\d*\z
Default: 1
Example: page_num=80

A positive integer value (i.e. 1 and up).

accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

title
any
Enum: "invoice" "payment"
invoice_id
integer (RELATION_ID) ^[1-9]\d*\z
Example: invoice_id=54321

A valid id number (a positive integer).

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "item_count": 12345,
  • "item_total": 12345,
  • "items": [
    ],
  • "page_num": 80,
  • "page_size": 80,
  • "page_total": 80
}

account/order

Place an order for services creating a new account.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
country
string (COUNTRY_CODE_SPECIFIC)

A valid ISO country code.

lname
string (NAME) ^(?i)[\P{IsC}]{1,100}\z

A valid name, up to 100 characters in length.

cjsid
string (LINE) ^[^[:cntrl:]]*\z

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

Array of objects
quoteName
string (LAXWORD) ^[\w-]*\z

A single word, consisting of only letters, digits, hyphens, and underscores.

zip
string (POSTAL_CODE) ^(?i)[a-z0-9.,#'/ -]{2,40}\z

A valid postal code.

tax_exempt_reason
string (LINE) ^[^[:cntrl:]]*\z

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

traits
Array of strings (ARRAY)

An array of arbitrary values.

paymentMethod
string (WORD_) ^\w+\z

A single word, consisting of only letters, digits, and underscores.

opportunity_id
string (LINE) ^[^[:cntrl:]]*\z

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

paymentInterval
string (WORD) ^(?i)[a-z0-9]*\z

A single word, consisting of only letters and digits.

phone
string (PHONE_GENERIC) ^(?i)[0-9extnsio.,()+ -]{2,25}\z

A valid phone number.

referredByType
string (STRING) ^.+\z

A string.

phone_code
integer (NON_NEG_INT) ^\d+\z
Example: phone_code=12345

A non-negative integer value (i.e. 0 and up).

tax_exempt
boolean (BOOLEAN)

A boolean value (0 or 1).

customer_uuid
string <uuid> (UUID) ^[[:xdigit:]]{8}-([[:xdigit:]]{4}-){3}[[:xdig...
Example: customer_uuid=f81d4fae-7dec-11d0-a765-00a0c91e6bf6

A valid UUID (Universally Unique IDentifier).

tax_id
string (LINE) ^[^[:cntrl:]]*\z

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

fname
string (NAME) ^(?i)[\P{IsC}]{1,100}\z

A valid name, up to 100 characters in length.

username
string (SUBACCNT_USERNAME) ^(?i)[-\w.@+]{2,63}\z

A subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).

sid
string (LINE) ^[^[:cntrl:]]*\z

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

domain
string <hostname> (DOMAIN_FULL)
Example: domain=example.com

A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

password
string (GENERIC_PASSWORD_BILLING_LENGTH) ^[^[:cntrl:]\t\r\n]{6,30}\z

A password of at least 6 characters and up to 30 characters in length, may contain spaces

tax_exempt_id
string (LINE) ^[^[:cntrl:]]*\z

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

email
string <email> (EMAIL_ADDR)
Example: email=user@example.com

A valid email address.

userComments
string (TEXT_GENERAL)

A string permitting tabs, carriage returns and newlines

address
string (STREET_ADDRESS) ^(?i)[\P{IsC}]{2,150}\z

A valid street address, up to 150 characters in length.

fax
string (PHONE_GENERIC) ^(?i)[0-9extnsio.,()+ -]{2,25}\z

A valid phone number.

city
string (CITY) ^(?i)[\P{IsC}]{2,80}\z

A valid city name.

referredBy
string (STRING) ^.+\z

A string.

is_shared_order
boolean (BOOLEAN)

A boolean value (0 or 1).

passwordVerify
string (GENERIC_PASSWORD_BILLING_LENGTH) ^[^[:cntrl:]\t\r\n]{6,30}\z

A password of at least 6 characters and up to 30 characters in length, may contain spaces

company
string (ORGNAME) ^(?i)[\P{IsC}]{2,100}\z

A valid company name, up to 100 characters in length.

cjaid
string (LINE) ^[^[:cntrl:]]*\z

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

state
string (STATE) ^(?i)[\pN\pL.,'/()<>_ -]{2,80}\z

A valid state or province.

address2
string (STREET_ADDRESS) ^(?i)[\P{IsC}]{2,150}\z

A valid street address, up to 150 characters in length.

phone_check
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: phone_check=80

A positive integer value (i.e. 1 and up).

coupon
string (COUPON_CODE) ^[a-zA-Z0-9_-]{6,40}\z

A 6 to 40 character coupon code

validated
boolean (BOOLEAN)

A boolean value (0 or 1).

cart
object (HASH)
Example:

An associative array of arbitrary keys and values.

cardCode
integer (CVV2) ^\d{3,4}\z

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).

is_san_order
boolean (BOOLEAN)

A boolean value (0 or 1).

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "accnt": 0,
  • "order_id": 80,
  • "order_type": "string",
  • "pending_configs": 12345,
  • "support_passphrase": "string"
}

account/upgrade

Place an order for services adding services to an existing account.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
coupon
string (COUPON_CODE) ^[a-zA-Z0-9_-]{6,40}\z

A 6 to 40 character coupon code

cjaid
string (LINE) ^[^[:cntrl:]]*\z

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

is_san_order
boolean (BOOLEAN)

A boolean value (0 or 1).

domain
string <hostname> (DOMAIN_FULL)
Example: domain=example.com

A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

sid
string (LINE) ^[^[:cntrl:]]*\z

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

cardCode
integer (CVV2) ^\d{3,4}\z

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
object (HASH)
Example:

An associative array of arbitrary keys and values.

referredByType
string (STRING) ^.+\z

A string.

customer_uuid
string <uuid> (UUID) ^[[:xdigit:]]{8}-([[:xdigit:]]{4}-){3}[[:xdig...
Example: customer_uuid=f81d4fae-7dec-11d0-a765-00a0c91e6bf6

A valid UUID (Universally Unique IDentifier).

is_shared_order
boolean (BOOLEAN)

A boolean value (0 or 1).

referredBy
string (STRING) ^.+\z

A string.

traits
Array of strings (ARRAY)

An array of arbitrary values.

paymentMethod
string (WORD_) ^\w+\z

A single word, consisting of only letters, digits, and underscores.

opportunity_id
string (LINE) ^[^[:cntrl:]]*\z

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

Array of objects
quoteName
string (LAXWORD) ^[\w-]*\z

A single word, consisting of only letters, digits, hyphens, and underscores.

cjsid
string (LINE) ^[^[:cntrl:]]*\z

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

userComments
string (TEXT_GENERAL)

A string permitting tabs, carriage returns and newlines

accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "accnt": 0,
  • "order_id": 80,
  • "order_type": "string",
  • "pending_configs": 12345,
  • "support_passphrase": "string"
}

Auth

This section contains methods to update and use an account's authentication credentials.

account/auth/claim_auth_hash

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
metadata
object (HASH)
Example:

An associative array of arbitrary keys and values.

hash
string (ONETIME_LINK_HASH) ^(?:[a-zA-Z0-9_-]{27}|[a-zA-Z0-9_-]{86})\z

A 27 or 86 character code for a single-use URI

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "received": true
}

account/auth/expiretoken

This method will expire an existing token immediately instead of waiting for it to expire on its own. This is useful if you want to forcibly stop the use of a token for security reasons.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "expired": true
}

account/auth/issuejwt

This method allows the caller to generate a JWT to access a specific service.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

uniq_id
string (SUBACCNT_UNIQ_ID) ^[A-HJ-NP-Z0-9]{6}\z

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

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{}

account/auth/token

Authentication tokens are short-term alternative credentials for an account. Once a user logs in with their password, you should use that password to generate an authentication token, which can be cached by your application. The authentication tokens time out after a specified period of inactivity (defaults to 15 minutes, maximum time is 1 hour).

Tokens can be kept alive by calling this method again before the token expires, up to a maximum of 12 hours. After 12 hours, the token will be expired permanently and a new token will need to be retrieved using the original password for your user.

Examples:

A token can be used to provide better password security, while still allowing an application to store credentials temporarily to avoid repeated logins.

  1. User logs in with their real password 2. You use that password to get a token 3. You store the token in their session and use it to authenticate on successive page hits.

This allows you to avoid the insecurity of storing their password in their session. And since the token is only good for a limited amount of time, the potential security threat is minimized.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
timeout
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: timeout=80

A positive integer value (i.e. 1 and up).

login_context
object (HASH)
Example:

An associative array of arbitrary keys and values.

accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "expires": 1697062935,
  • "token": "string"
}

account/auth/validatejwt

This method will check and ensure that a given JSON WebToken is valid. Once a JWT's validation is checked it will not be valid again. This method will only be accessible to NonAccountUsers and will be a way to authenticate users.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
signed_for
string (SUBACCNT_UNIQ_ID) ^[A-HJ-NP-Z0-9]{6}\z

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

jwt
string (JWT) ^[a-zA-Z0-9\-_]+?\.[a-zA-Z0-9\-_]+?\.[a-zA-Z0...

A JSON Web Token.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "agent": "string",
  • "agent_signature": "string",
  • "claims": { },
  • "expires": 1697062935,
  • "token": "string",
  • "username": "string"
}

Auth/TwoFactor

This section contains methods for setting up, enabling, and disabling two-factor authentication (TFA).

account/auth/twofactor/activation_key

If two-factor authentication (TFA) is not already enabled: Creates a new TFA activation key, applies it to the user, and returns it.

If TFA is already enabled: An exception will be thrown. To generate a fresh key, disable TFA and then call this method.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
username
string (SUBACCNT_USERNAME) ^(?i)[-\w.@+]{2,63}\z

A subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).

accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "key": "string"
}

account/auth/twofactor/disable

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
passcode
integer (TWOFACTOR_PASSCODE) ^\d{6}\z
Example: passcode=123456

A six digit TFA passcode

accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

username
string (SUBACCNT_USERNAME) ^(?i)[-\w.@+]{2,63}\z

A subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "disabled": true
}

account/auth/twofactor/enable

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
passcode
integer (TWOFACTOR_PASSCODE) ^\d{6}\z
Example: passcode=123456

A six digit TFA passcode

accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

username
string (SUBACCNT_USERNAME) ^(?i)[-\w.@+]{2,63}\z

A subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "enabled": true
}

BillingAddress

This section contains methods to interact with a billing-specific address for an account.

account/billingaddress/delete

Remove the billing-specific address for an account.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "accnt": 0,
  • "address": "string",
  • "address2": "string",
  • "city": "string",
  • "country": "string",
  • "postal_code": "string",
  • "separate_billing_address": true,
  • "state": "string"
}

account/billingaddress/details

This method will return an address for the account: the billing-specific address if it exists, the default address otherwise.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "accnt": 0,
  • "address": "string",
  • "address2": "string",
  • "city": "string",
  • "country": "string",
  • "postal_code": "string",
  • "separate_billing_address": true,
  • "state": "string"
}

account/billingaddress/updateorcreate

Add or update a billing-specific address for an account.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
address
string (STREET_ADDRESS) ^(?i)[\P{IsC}]{2,150}\z

A valid street address, up to 150 characters in length.

city
string (CITY) ^(?i)[\P{IsC}]{2,80}\z

A valid city name.

accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

address2
string (STREET_ADDRESS) ^(?i)[\P{IsC}]{2,150}\z

A valid street address, up to 150 characters in length.

postal_code
string (POSTAL_CODE) ^(?i)[a-z0-9.,#'/ -]{2,40}\z

A valid postal code.

country
string (COUNTRY) ^(?i)[\pN\pL.,'/()<>_ -]{2,80}\z

A valid country.

state
string (STATE) ^(?i)[\pN\pL.,'/()<>_ -]{2,80}\z

A valid state or province.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "accnt": 0,
  • "address": "string",
  • "address2": "string",
  • "city": "string",
  • "country": "string",
  • "postal_code": "string",
  • "separate_billing_address": true,
  • "state": "string"
}

ChatPassword

This section contains methods to update and use an account users support (previously chat) password.

The support password is a phrase that can be used to authenticate with
a support technician. It is not considered as sensitive as the account
password.

account/chatpassword/executereset

Updates the Support Passphrase for the account associated with the given hash.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
passphrase
string (TEXT_GENERAL)

A string permitting tabs, carriage returns and newlines

hash
string (ONETIME_LINK_HASH) ^(?:[a-zA-Z0-9_-]{27}|[a-zA-Z0-9_-]{86})\z

A 27 or 86 character code for a single-use URI

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "ok": true
}

account/chatpassword/get

Returns the support password for the current account and user, if any.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "password": "string"
}

account/chatpassword/set

Sets the support password for the current account and user. The support password can be deleted by setting the password field on this method to an empty string.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
password
string (TEXT_GENERAL)

A string permitting tabs, carriage returns and newlines

accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "password": "string"
}

account/chatpassword/visitreset

Returns whether or not the requested link is valid.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
hash
string (ONETIME_LINK_HASH) ^(?:[a-zA-Z0-9_-]{27}|[a-zA-Z0-9_-]{86})\z

A 27 or 86 character code for a single-use URI

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "ok": true
}

Contact

This section contains methods to fetch and update an account's contact information.

account/contact/get

Returns the contact information for the logged in account. Some fields may come back as null, if no value was entered for them.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "accnt": 0,
  • "address": "string",
  • "cc": "user@example.com",
  • "city": "string",
  • "company": "string",
  • "country": "string",
  • "email": [
    ],
  • "fax": "555-555-5555",
  • "fname": "string",
  • "lname": "string",
  • "mname": "string",
  • "phone": "string",
  • "state": "string",
  • "tax_id": "string",
  • "zip_code": "string"
}

account/contact/update

Updates the contact information for the logged in account.

If you need to transfer ownership of the account to another party or correct the spelling of your name, please call us at 1-877-330-7660.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

address
string (STREET_ADDRESS) ^(?i)[\P{IsC}]{2,150}\z

A valid street address, up to 150 characters in length.

company
string (ORGNAME) ^(?i)[\P{IsC}]{2,100}\z

A valid company name, up to 100 characters in length.

EMAIL_ADDR (string) or Array of EMAIL_ADDR_LIST (strings) or Array of MULTI_TYPE (strings) (MULTI_TYPE)

One of [EMAIL_ADDR] or [EMAIL_ADDR_LIST] or [ARRAY[EMAIL_ADDR]].

country
string (COUNTRY_OR_CODE_SPECIFIC)

A valid ISO country code or name.

lname
string (NAME) ^(?i)[\P{IsC}]{1,100}\z

A valid name, up to 100 characters in length.

phone
string (PHONE_GENERIC) ^(?i)[0-9extnsio.,()+ -]{2,25}\z

A valid phone number.

EMAIL_ADDR (string) or Array of MULTI_TYPE (strings) or Array of EMAIL_ADDR_LIST (strings) (MULTI_TYPE)

One of [EMAIL_ADDR] or [ARRAY[EMAIL_ADDR]] or [EMAIL_ADDR_LIST].

fax
string (FAX_GENERIC) ^(?i)[0-9extnsio.,()+ -]{2,25}\z
Example: fax=555-555-5555

A valid fax number.

city
string (CITY) ^(?i)[\P{IsC}]{2,80}\z

A valid city name.

mname
string (NAME) ^(?i)[\P{IsC}]{1,100}\z

A valid name, up to 100 characters in length.

tax_id
string (LINE) ^[^[:cntrl:]]*\z

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

state
string (STATE) ^(?i)[\pN\pL.,'/()<>_ -]{2,80}\z

A valid state or province.

fname
string (NAME) ^(?i)[\P{IsC}]{1,100}\z

A valid name, up to 100 characters in length.

zip_code
string (POSTAL_CODE) ^(?i)[a-z0-9.,#'/ -]{2,40}\z

A valid postal code.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "accnt": 0,
  • "address": "string",
  • "cc": [
    ],
  • "city": "string",
  • "company": "string",
  • "country": "string",
  • "email": [
    ],
  • "fax": "555-555-5555",
  • "fname": "string",
  • "lname": "string",
  • "mname": "string",
  • "phone": "string",
  • "state": "string",
  • "tax_id": "string",
  • "zip_code": "string"
}

CreditCard

This section contains methods to update and use an account's credit card.

account/creditcard/details

Returns the (masked) credit card number and credit card expiration month for the current account, if any.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "credit_card_exp": "string",
  • "credit_card_num": "string"
}

Cycle

API methods for fetching all defined billing cycles for an account.

account/cycle/list

Returns all defined billing cycles for an account along with relevant dates.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

page_num
integer (POSITIVE_INT) ^[1-9]\d*\z
Default: 1
Example: page_num=80

A positive integer value (i.e. 1 and up).

page_size
integer (POSITIVE_INT) ^[1-9]\d*\z
Default: 25
Example: page_size=80

A positive integer value (i.e. 1 and up).

object
Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "item_count": 12345,
  • "item_total": 12345,
  • "items": [
    ],
  • "page_num": 80,
  • "page_size": 80,
  • "page_total": 80
}

Limits

This module provides APIs for accessing the various limits we place on an account.

account/limits/dynamicchild

Returns the minimum allowed configuration setting for a dynamic child instance residing on a private parent. These values are dependent upon the management level of the desired template, and the guest operating system chosen.

If your circumstances require variations on these minimums, please call us at 1-877-330-7660

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

childType
any
Enum: "Managed" "Unmanaged" "Windows"
property
any
Enum: "Memory" "Disk" "Cpu"
Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "Managed": {
    },
  • "Unmanaged": {
    },
  • "Windows": {
    }
}

account/limits/ip

Returns the maximum number of IPs your account may have per server.

If you require additional IPs per server on your account please call us at 1-877-330-7660

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "limit": 80,
  • "limit_ipv6": 80,
  • "nocworx_openstack_limit": 80
}

account/limits/ippool

Returns the maximum number of IPs your account may have per IP Pool.

If you require additional IPs per IP Pool on your account please call us at 1-877-330-7660

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "limit": 80
}

account/limits/servers

Returns the maximum number of Storm servers the currently logged-in account is allowed to have.

If you require additional servers on your account please call us at 1-877-330-7660

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "limit": 80,
  • "used": 12345
}

Paymethod

This section contains methods to fetch and update an account's payment information.

NOTE: DEPRECATED. The methods here are more billing related than
account related and have been moved to the billing section =cut

our @FIELDS = qw(accnt cycle payment_method credit_card_num
credit_card_exp card_code);

account/paymethod/balance

When you destroy servers or turn off optional features, money is added to your balance to either pay for new servers or cover part of your next bill. This method allows you to determine how much balance you have available.

A second field, due, is the amount of charges in your account that have not yet been reconciled. Usually charges are reconciled on your billing date.

NOTE DEPRECATED. Moved to billing.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "available": "string",
  • "balance": "string",
  • "credit": "string",
  • "cycle": "string",
  • "cycles": [
    ],
  • "due": "string",
  • "last_payment_date": "2012-04-23",
  • "next_bill_date": "2012-04-23",
  • "next_dates": [
    ],
  • "overdue": "string",
  • "payment_method": "string"
}

account/paymethod/get

Returns the current payment configuration for the logged in account.

Only the last 4 digits of the credit card number are returned, for obvious security reasons.

NOTE DEPRECATED. Moved to billing.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "accnt": 0,
  • "credit_card_exp": "string",
  • "credit_card_num": "string",
  • "cycle": "string",
  • "payment_method": "string"
}

Settings

This section contains methods for account settings.

account/settings/get

Returns settings for the logged in account.

not_new = The welcome screen has been displayed.
hide_social = Hide social media buttons.
Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "hide_social": true,
  • "not_new": true
}

account/settings/hastrait

Check if an account has the specified trait.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
trait
string (WORD) ^(?i)[a-z0-9]*\z

A single word, consisting of only letters and digits.

accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "has_trait": true
}

account/settings/update

Updates the current settings for the logged in account.

not_new = The welcome screen has been displayed.
hide_social = Hide social media buttons.
Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
hide_social
boolean (BOOLEAN)

A boolean value (0 or 1).

accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

new_account
boolean (BOOLEAN)

A boolean value (0 or 1).

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "hide_social": true,
  • "not_new": true
}

Subscriptions

This section contains methods adjust which automatic mailings an account receives.

account/subscriptions/get

Returns the current subscription settings for the logged in account.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "newsletter": true,
  • "promotions": true
}

account/subscriptions/update

Updates the current subscription settings for the logged in account.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

promotions
boolean (BOOLEAN)

A boolean value (0 or 1).

newsletter
boolean (BOOLEAN)

A boolean value (0 or 1).

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "newsletter": true,
  • "promotions": true
}

User

This section contains methods to manage the various users an account contains. This includes both StormOnDemand.com users and api users.

account/user/available

This method can be used to determine whether a username is currently available.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
username
string (SUBACCNT_USERNAME) ^(?i)[-\w.@+]{2,63}\z

A subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "available": true
}

account/user/create

Creates a new user with the role designated. This user will immediately be able to login and access the functions appropriate to their role.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
firstname
string (PERMISSIONS_NAME) ^[^[:cntrl:]]{1,50}\z

The first, middle, or last name of an individual, up to 50 characters in length.

email
string <email> (EMAIL_ADDR)
Example: email=user@example.com

A valid email address.

lastname
string (PERMISSIONS_NAME) ^[^[:cntrl:]]{1,50}\z

The first, middle, or last name of an individual, up to 50 characters in length.

roles
Array of strings (PERMISSIONS_ROLE)
username
string (SUBACCNT_USERNAME) ^(?i)[-\w.@+]{2,63}\z

A subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).

accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

password
string (GENERIC_PASSWORD_LENGTH) ^[^[:cntrl:]\t\r\n]{6,100}\z

A password of at least 6 characters and up to 100 characters in length, may contain spaces

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "active": true,
  • "email": "user@example.com",
  • "federation_id": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "name": "string",
  • "roles": [
    ],
  • "suspended": true,
  • "tfa_enabled": true,
  • "username": "string"
}

account/user/details

Get information about a specific user on this account.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

username
string (SUBACCNT_USERNAME) ^(?i)[-\w.@+]{2,63}\z

A subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "active": true,
  • "email": "user@example.com",
  • "federation_id": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "name": "string",
  • "roles": [
    ],
  • "suspended": true,
  • "tfa_enabled": true,
  • "username": "string"
}

account/user/list

Get a list of the current users for this account.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

page_num
integer (POSITIVE_INT) ^[1-9]\d*\z
Default: 1
Example: page_num=80

A positive integer value (i.e. 1 and up).

page_size
integer (POSITIVE_INT) ^[1-9]\d*\z
Default: 25
Example: page_size=80

A positive integer value (i.e. 1 and up).

active
boolean (BOOLEAN)

A boolean value (0 or 1).

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "item_count": 12345,
  • "item_total": 12345,
  • "items": [
    ],
  • "page_num": 80,
  • "page_size": 80,
  • "page_total": 80
}

account/user/roles

Gets a list of available roles.

Authorizations:
BearerAuthHTTPBasicAuth
Request Body schema: application/json
required
params
required
object

Responses

Request samples

Content type
application/json
{
  • "params": { }
}

Response samples

Content type
application/json
Example
{
  • "roles": [
    ]
}

account/user/update

Updates an existing user.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
username
string (SUBACCNT_USERNAME) ^(?i)[-\w.@+]{2,63}\z

A subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).

roles
Array of strings (PERMISSIONS_ROLE)
existing_user
string (SUBACCNT_USERNAME) ^(?i)[-\w.@+]{2,63}\z

A subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).

password
string (GENERIC_PASSWORD_LENGTH) ^[^[:cntrl:]\t\r\n]{6,100}\z

A password of at least 6 characters and up to 100 characters in length, may contain spaces

firstname
string (PERMISSIONS_NAME) ^[^[:cntrl:]]{1,50}\z

The first, middle, or last name of an individual, up to 50 characters in length.

accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

active
boolean (BOOLEAN)

A boolean value (0 or 1).

lastname
string (PERMISSIONS_NAME) ^[^[:cntrl:]]{1,50}\z

The first, middle, or last name of an individual, up to 50 characters in length.

email
string <email> (EMAIL_ADDR)
Example: email=user@example.com

A valid email address.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "active": true,
  • "email": "user@example.com",
  • "federation_id": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "name": "string",
  • "roles": [
    ],
  • "suspended": true,
  • "tfa_enabled": true,
  • "username": "string"
}

Asset

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.

asset/connections

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
no_groups
boolean (BOOLEAN)

Some operations can be made faster by not requesting the group data

relationship_types
Array of strings (WORD_)
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

uniq_id
string (SUBACCNT_UNIQ_ID) ^[A-HJ-NP-Z0-9]{6}\z

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

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "details": { },
  • "groups": { },
  • "rows": [
    ]
}

asset/details

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

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
uniq_id
string (SUBACCNT_UNIQ_ID) ^[A-HJ-NP-Z0-9]{6}\z

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

alsowith
Array of any
Items Enum: "acronisBackingUp" "ancestorServer" "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" "productDisplayGroup" "project" "prometheusDetails" "publicProductCategory" "resourceState" "servers" "shortDescription" "usageDetails" "zone"
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "active": true,
  • "domain": "string",
  • "ip": "172.0.0.1",
  • "project_id": 80,
  • "project_name": "string",
  • "region_id": 80,
  • "status": "New",
  • "type": "string",
  • "uniq_id": "string",
  • "username": "string"
}

asset/list

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

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
page_num
integer (POSITIVE_INT) ^[1-9]\d*\z
Default: 1
Example: page_num=80

A positive integer value (i.e. 1 and up).

accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

alsowith
Array of any
Items Enum: "acronisBackingUp" "ancestorServer" "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" "productDisplayGroup" "project" "prometheusDetails" "publicProductCategory" "resourceState" "servers" "shortDescription" "usageDetails" "zone"
status
string (SUBACCNT_STATUS)

A valid subaccnt status (New, Active, BucketPart, Disabled, Terminated, Pending-Termination, Pending-Activation, Pending-Payment, Pending-Config).

category
Array of strings (WORD)
public_category
string (WORD) ^(?i)[a-z0-9]*\z

A single word, consisting of only letters and digits.

capability
string (WORD) ^(?i)[a-z0-9]*\z

A single word, consisting of only letters and digits.

exclude_category
Array of strings (WORD)
domain_match
boolean (BOOLEAN)

Find all assets via partial domain match rather than exact match

page_size
integer (POSITIVE_INT) ^[1-9]\d*\z
Default: 25
Example: page_size=80

A positive integer value (i.e. 1 and up).

domain
string (MULTI_TYPE)

One of [DOMAIN_FRAGMENT] or [DOMAIN_FULL].

uniq_id
Array of strings (SUBACCNT_UNIQ_ID)
project_name
string (TEXT_GENERAL)

A string permitting tabs, carriage returns and newlines

ACCOUNT_TYPE (string) or Array of MULTI_TYPE (strings) (MULTI_TYPE)

One of [ACCOUNT_TYPE] or [ARRAY[ACCOUNT_TYPE]].

object
Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "item_count": 12345,
  • "item_total": 12345,
  • "items": [
    ],
  • "page_num": 80,
  • "page_size": 80,
  • "page_total": 80
}

asset/remove

Request removal of this asset.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
uniq_id
string (SUBACCNT_UNIQ_ID) ^[A-HJ-NP-Z0-9]{6}\z

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

rating
any
Enum: 0 5 10

Rating of customer's experience with Liquid Web.

accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

cancellation_reason
string (TEXT_GENERAL)

A string permitting tabs, carriage returns and newlines

cancellation_comment
string (TEXT_GENERAL)

A string permitting tabs, carriage returns and newlines

cleanup_assets
boolean (BOOLEAN)

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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "removal_requested": "string"
}

asset/startpciscan

Launch a PCI scan for a PCI service subaccnt. Results will be sent as PDF attachments to a Salesforce ticket.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

uniq_id
string (SUBACCNT_UNIQ_ID) ^[A-HJ-NP-Z0-9]{6}\z

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

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "scan_started": true
}

asset/update

Change the details of a subaccnt.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
domain
string <hostname> (DOMAIN_FULL)
Example: domain=example.com

A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

features
object (HASH)
Example:

An associative array of arbitrary keys and values.

uniq_id
string (SUBACCNT_UNIQ_ID) ^[A-HJ-NP-Z0-9]{6}\z

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

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "accnt": 0,
  • "active": true,
  • "capabilities": { },
  • "categories": [
    ],
  • "description": "string",
  • "domain": "string",
  • "features": { },
  • "ip": "172.0.0.1",
  • "region_id": 80,
  • "type": "string",
  • "uniq_id": "string",
  • "username": "string",
  • "valid_source_hvs": { }
}

Measurements

This section of the API allows for interacting with a subaccount's measurements.

asset/measurements/available

Returns available measurements and their fields of which to pull measurement data.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
uniq_id
string (SUBACCNT_UNIQ_ID) ^[A-HJ-NP-Z0-9]{6}\z

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

accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "available": { }
}

asset/measurements/current

Returns current measurements for all available measurements.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
uniq_id
string (SUBACCNT_UNIQ_ID) ^[A-HJ-NP-Z0-9]{6}\z

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

accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "current": { }
}

asset/measurements/lookup

Lookup measurements for given fields and duration of a subaccnt. Return all measurement points as per lookup arguments.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
function
any
Default: "MEAN"
Enum: "LAST" "FIRST" "MEAN" "MODE" "SUM" "MAX" "MIN"
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

duration
any
Enum: "2week" "month" "3month" "3day" "12hour" "6hour" "day"
object
fields
Array of strings (WORD_)
uniq_id
string (SUBACCNT_UNIQ_ID) ^[A-HJ-NP-Z0-9]{6}\z

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

name
string (WORD_) ^\w+\z

A single word, consisting of only letters, digits, and underscores.

difference
boolean (BOOLEAN)

A boolean value (0 or 1).

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

Monitoring

This section of the API allows for remotely querying service status data, service monitoring configuration details, setting the monitoring configuration for a server, as well as converting an asset or account between different monitoring backends.

asset/monitoring/assert

Declares the state of the monitoring settings for a given subaccount. if the settings record doesn't exists, it will be created.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
enabled
boolean (BOOL)

A boolean value (0 or 1).

Array of objects
subaccnt
string (UNIQ_ID) ^[A-HJ-NP-Z0-9]{6}\z

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

accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "enabled": true,
  • "ip": "string",
  • "labels": { },
  • "server_pair": "string",
  • "services": [
    ],
  • "subaccnt": "string"
}

asset/monitoring/details

Returns monitoring details for a requested subaccount.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

subaccnt
string (UNIQ_ID) ^[A-HJ-NP-Z0-9]{6}\z

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

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "enabled": true,
  • "ip": "string",
  • "labels": { },
  • "server_pair": "string",
  • "services": [
    ],
  • "subaccnt": "string"
}

asset/monitoring/list

Returns a list of all monitoring details for a given search.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
subaccnt
string (UNIQ_ID) ^[A-HJ-NP-Z0-9]{6}\z

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

enabled
boolean (BOOLEAN)
Default: 1

A boolean value (0 or 1).

server_pair
string (LINE) ^[^[:cntrl:]]*\z

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

page_num
integer (POSITIVE_INT) ^[1-9]\d*\z
Default: 1
Example: page_num=80

A positive integer value (i.e. 1 and up).

accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

(Array of MULTI_TYPE (Array of ARRAY (strings) or WORD_ (string))) or WORD_ (string) (MULTI_TYPE)

One of [ARRAY[WORD_|ARRAY]] or [WORD_].

page_size
integer (POSITIVE_INT) ^[1-9]\d*\z
Default: 25
Example: page_size=80

A positive integer value (i.e. 1 and up).

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "item_count": 12345,
  • "item_total": 12345,
  • "items": [
    ],
  • "page_num": 80,
  • "page_size": 80,
  • "page_total": 80
}

asset/monitoring/status

returns the current monitoring status of the given monitored services.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

subaccnt
string (UNIQ_ID) ^[A-HJ-NP-Z0-9]{6}\z

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

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "DYNAMIC[LINE]": { }
}

Bill

A bill is collection of invoices that a customer owes at the time the bill was generated.

***** NOTE *****

    These methods have been moved here from billing->invoice

    In order to help clear up confusion, we have made an effort to
    separate bills and invoices. Originally, to try and make things
    simpler, we attempted to make bills and invoices appear more like
    one thing. This, unfortunately, did not work as well as intended.
    In making things more transparent, the API methods involving Bills
    and Invoices have been refined.

billing/bill/details

Returns data specific to one bill. In addition to what is returned in the list method, additional details about the specific lineitems are included.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
WORD_ (string) or (Array of MULTI_TYPE (Array of ARRAY (strings) or WORD_ (string))) (MULTI_TYPE)

One of [WORD_] or [ARRAY[WORD_|ARRAY]].

accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

id
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: id=80

A positive integer value (i.e. 1 and up).

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "accnt": 0,
  • "bill_date": "2012-04-23",
  • "due": "string",
  • "end_date": "2012-04-23",
  • "id": 54321,
  • "invoices": [
    ],
  • "payments": [
    ],
  • "start_date": "2012-04-23",
  • "status": "string",
  • "total": "string",
  • "type": "string"
}

billing/bill/list

Returns a list of all the bills for the logged in account. Bills are created at your regular billing date, but are also created for one-off items like creating or cloning a server.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
WORD_ (string) or (Array of MULTI_TYPE (WORD_ (string) or Array of ARRAY (strings))) (MULTI_TYPE)

One of [WORD_] or [ARRAY[WORD_|ARRAY]].

page_size
integer (POSITIVE_INT) ^[1-9]\d*\z
Default: 25
Example: page_size=80

A positive integer value (i.e. 1 and up).

accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

page_num
integer (POSITIVE_INT) ^[1-9]\d*\z
Default: 1
Example: page_num=80

A positive integer value (i.e. 1 and up).

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "item_count": 12345,
  • "item_total": 12345,
  • "items": [
    ],
  • "page_num": 80,
  • "page_size": 80,
  • "page_total": 80
}

Credit

This section contains methods for viewing account credits.

billing/credit/details

Provides details of a given account credit

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
WORD_ (string) or (Array of MULTI_TYPE (WORD_ (string) or Array of ARRAY (strings))) (MULTI_TYPE)

One of [WORD_] or [ARRAY[WORD_|ARRAY]].

accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

id
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: id=80

A positive integer value (i.e. 1 and up).

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "accnt": 0,
  • "balance": "string",
  • "comments": "string",
  • "created_date": "string",
  • "id": 54321,
  • "original_amount": "string",
  • "reason": "string",
  • "transactions": [
    ],
  • "valid_after": "string",
  • "valid_until": "string"
}

billing/credit/list

List credits on the account

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
object
page_num
integer (POSITIVE_INT) ^[1-9]\d*\z
Default: 1
Example: page_num=80

A positive integer value (i.e. 1 and up).

accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

A valid account number, up to 6 digits in length.

page_size
integer (POSITIVE_INT) ^[1-9]\d*\z
Default: 25
Example: page_size=80

A positive integer value (i.e. 1 and up).

(Array of MULTI_TYPE (WORD_ (string) or Array of ARRAY (strings))) or WORD_ (string) (MULTI_TYPE)

One of [ARRAY[WORD_|ARRAY]] or [WORD_].

Request Body schema: application/json
required
required
object

Responses

Request samples