Liquidweb.com
API docs by Redocly

Liquid Web API (v2)

Liquid Web API Support: support@liquidweb.com URL: https://www.liquidweb.com/contact-us/ License: Apache 2.0 Terms of Service

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

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
}

Cycle

API methods for fetching all possible billing cycles

billing/cycle/list

Returns all possible billing cycles and their length, in months.

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

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

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
{
  • "items": [
    ]
}

Invoice

An invoice is a record of specific charges owed by the customer for a set of services. A bill is a point of communication with a customer. When Liquid Web bills a customer, it gathers any outstanding invoices, generates any new invoices if needed and sends them to the customer.

There are three ways an invoice could be generated:

* 1.

  Any time a service is added or removed from an account an invoice is
  generated.

* 2.

  During the normal billing time for an account, an invoice is
  generated for the upcoming month.

* 3.

  For certain services where it is impossible to know how much to
  charge until we know the usage for the service, we charge for the
  previous month's usage. If an account has charges for any of those
  services (backups, bandwidth overages, etc), an additional invoice
  will be generated for those services *only*.

***** NOTE *****

    Bills related methods have been moved to billing->bill

    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. In order to maintain backwards
    compatibility, the version 1 (v1) methods will continue to refer to
    bills rather than invoices. *Moving forward, including the bleed
    version, the methods will be referring solely to invoices.* This
    means that a list method called as v1 will return different data
    than the bleed version.

    Exceptions to this rule: Any method that only existed as a bleed
    method prior to the separation of bills and invoices. These methods
    have been completely moved to billing->bill and are no longer
    available under billing->invoice.

billing/invoice/details

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
preview
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.

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,
  • "allocated_payments": [
    ],
  • "amounts": {
    },
  • "billed_date": "2012-04-23",
  • "dependency_status": "string",
  • "due_date": "2012-04-23",
  • "exchange_currency": "string",
  • "exchange_rate": "string",
  • "generated_date": "string",
  • "id": 54321,
  • "id_display": "string",
  • "is_past_due": true,
  • "lineitem_groups": [
    ],
  • "local_jurisdiction_id": 54321,
  • "local_tax_converted": "string",
  • "payment_status": "string",
  • "payments": [
    ],
  • "reason": "string",
  • "reason_display": "string",
  • "revision": 12345,
  • "serv_end_date": "2012-04-23",
  • "serv_start_date": "2012-04-23",
  • "tax_rate": 1.25
}

billing/invoice/list

v1

Deprecated. This method has been moved to 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.

bleed

Returns a list of all the invoices for the logged in account.
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).

with_previews
boolean (BOOLEAN)
Default: 1

Include invoice previews, if they exist.

only_statuses
Array of strings (LAXWORDS)

Allows a user to limit the list of invoices returned based on the status of the invoice. Statuses include: unpaid, partially-paid and paid.

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

bill_id
integer (RELATION_ID) ^[1-9]\d*\z
Example: bill_id=54321

Pass in a specific bill id to retrieve a list of invoices only associated with the requested bill.

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

Available options: payments, line_items.

If needed, you can request that either payments, line_items, or both can be returned when calling list. They are automatically returned when using the details method.

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
}

Invoice/Preview

Provides a preview invoice allowing customers to better estimate their future bill. Does not include post-facto charges.

billing/invoice/preview/details

Returns data specific to one preview invoice.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
id
integer (RELATION_ID) ^[1-9]\d*\z
Example: id=54321

A valid id number (a positive integer).

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,
  • "created_date": "string",
  • "id": 54321,
  • "json_data": { }
}

billing/invoice/preview/list

Return a list of preview records for the account.

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.

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

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

fresh
boolean (BOOLEAN)

A boolean value (0 or 1).

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
}

Backup

For customers with a backup plan, their servers are backed up daily. This section of the api allows remote interaction with those backups.

cloud/backup/details

Get information about a specific backup.

Here's a rundown of what the returned fields mean:

accnt: your account number

id: the id of the backup

features: an associate array of feature data that will be applied to any
server created from this backup

name: a displayable backup name

size: the size of the backup, in GB

template: the name of the OS template image from which this backup was created

time_taken: the date and time at which the backup was created

uniq_id: the unique server identifier, made of 6 letters and numbers,
of the server from which this backup was created
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.

id
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: id=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.

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,
  • "features": { },
  • "hv_type": "string",
  • "id": 80,
  • "name": "string",
  • "size": "123",
  • "template": "string",
  • "time_taken": "string",
  • "uniq_id": "string"
}

cloud/backup/list

Get a paginated list of backups for a particular server. More information about the data returned can be found under the documentation for cloud/backup/details

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

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

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
{
  • "item_count": 12345,
  • "item_total": 12345,
  • "items": [
    ],
  • "page_num": 80,
  • "page_size": 80,
  • "page_total": 80
}

cloud/backup/restore

Re-images a server with the backup image requested. If the 'force' flag is passed it will rebuild the filesystem on the server before restoring. This option is not usually needed, but if regular restores are failing, it can fix some scenarios.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
force
boolean (BOOLEAN)

A boolean value (0 or 1).

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.

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
{
  • "restored": "string"
}

Config

The list of available cloud (Storm) server configurations is found here.

cloud/config/details

Get information about a specific config.

Here's a rundown of what those fields mean:

active: a flag indicating whether this server configuration is currently active

available: a flag indicating whether any machines are available for this
server configuration

description: a description of the configuration type. 'Storm 2GB', for example.

disk: the amount of available disk space, in GB

featured: some configurations are flagged as 'featured' so we show them on
the Storm home page.  This flag is devoid of any meaning otherwise.

id: the id of this server configuration.  Use this values as the 'config_id'
in cloud/server/create and cloud/server/resize

memory: the amount of available RAM, in MB

price: a data structure giving the hourly price and estimated monthly price
of this configuration

zone_availability: a data structure giving the availability of this config
for in various zones.

vcpu: the number of CPUs available to this configuration
Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
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
{
  • "active": true,
  • "available": 12345,
  • "category": "string",
  • "cpu_cores": 80,
  • "cpu_count": 80,
  • "cpu_hyperthreading": true,
  • "cpu_model": "string",
  • "cpu_speed": 80,
  • "description": "string",
  • "disk": 80,
  • "disk_count": 12345,
  • "disk_total": 12345,
  • "disk_type": "string",
  • "featured": true,
  • "id": 80,
  • "memory": 80,
  • "raid_level": 12345,
  • "ram_available": 80,
  • "ram_total": 80,
  • "retired": true,
  • "vcpu": 80,
  • "zone_availability": { }
}

cloud/config/list

Get a list of available server configurations. Only active configurations will be returned by this method, whereas the 'details' method will allow you to query information about an inactive configuration. For more information about the fields returned here, refer to the documentation for cloud/config/details.

valid options for category are storm, ssd, bare-metal and all.

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

available
boolean (BOOLEAN)

A boolean value (0 or 1).

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

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

category
string (LAXWORD) ^[\w-]*\z
Default: "storm"

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

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
}

IP/Pool

IP Pool operations.

cloud/ip/pool/list

Get a list of available IPs from the pool.

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.

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

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

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

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

region
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: region=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
}

Image

Customer can create images of their server's hard drive on-demand. This section of the API allows remote interaction with those images.

cloud/image/create

Fires off a process to image the server right now. Since the image won't be created immediately, we can't return the information about it.

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.

name
string (TEXT_GENERAL) <= 80 characters

A string permitting tabs, carriage returns and newlines

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

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

cloud/image/delete

Fires off a process to delete the requested image from the image server that stores it.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
id
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: id=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.

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

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

cloud/image/details

Get information about a specific image.

Here's a rundown of what those fields mean:

accnt: your account number

id: the id of the image

features: an associate array of feature data that will be applied to any
server created from this image

name: the name you gave when you created the image

size: the size of the image, in GB

source_hostname: the hostname of the server from which this image was created

source_uniq_id: the unique server identifier, made of 6 letters and numbers,
of the server from which this image was created

template: the name of the OS template image from which this image was created

template_description: a more informative description of the OS of this image.
'CentOS 5.5 64bit Core-Managed', for example.

time_taken: the date and time at which the image was captured
Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
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,
  • "features": { },
  • "hv_type": "string",
  • "id": 80,
  • "name": "string",
  • "size": "123",
  • "source_hostname": "example.com",
  • "source_uniq_id": "string",
  • "template": "string",
  • "template_description": "string",
  • "time_taken": "string"
}

cloud/image/list

Get a paginated list of previously-created images for your account. More information about the returned data structure can be found in the documentation for server/image/details

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

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
}

cloud/image/restore

Re-images a server with the image requested. If the 'force' flag is passed it will rebuild the filesystem on the server before restoring. This option is not usually needed, but if regular restores are failing, it can fix some scenarios.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
force
boolean (BOOLEAN)

A boolean value (0 or 1).

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

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

id
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: id=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.

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

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

cloud/image/update

Update an existing image. Currently, only renaming the image is supported. More information about the returned data structure can be found in the documentation for server/image/details/

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
id
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: id=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.

name
string (TEXT_GENERAL) <= 80 characters

A string permitting tabs, carriage returns and newlines

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,
  • "features": { },
  • "hv_type": "string",
  • "id": 80,
  • "name": "string",
  • "size": "123",
  • "source_hostname": "example.com",
  • "source_uniq_id": "string",
  • "template": "string",
  • "template_description": "string",
  • "time_taken": "string"
}

Private/Parent

This section of the API provides convenience methods for managing Private Cloud Parents.

cloud/private/parent/create

Reserver a new private parent for your account. This method takes

config_id: the id of the server configuration you wish to use.  For a list
of available configs, see the cloud/config/list API method.  For private
parents, only bare-metal configs may be used.

zone: The zone id you wish to reserve this parent in.  Only KVM zones
are supported for private parents.

domain:  All servers at liquidweb must have a domain, however for
private parents this is only a user facing label.  As such it does
not have to be a valid DNS name.

This method returns the same data as the details method.

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

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

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

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

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

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

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,
  • "config_description": "string",
  • "config_id": 80,
  • "create_date": "string",
  • "domain": "string",
  • "id": 80,
  • "license_state": "string",
  • "region_id": 80,
  • "resources": {
    },
  • "subaccnt": 80,
  • "type": "string",
  • "uniq_id": "string",
  • "vcpu": 80,
  • "zone": {
    }
}

cloud/private/parent/delete

Removes a private parent from your account. This method will return an exception if your parent is not empty.

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
{
  • "deleted": "string"
}

cloud/private/parent/details

Gets data relevant to a Private Cloud Parent.

Here's a rundown of what the returned fields mean:

accnt: your account number

active: a flag indicating whether the server has finished building

config_id: the id of the server configuration this server is using

region_id: the of the region that this parent is in.

resourceState: A list of hashes, describing the current resources
available on this parent.

uniq_id: the unique server identifier, made of 6 letters and numbers
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
{
  • "accnt": 0,
  • "config_description": "string",
  • "config_id": 80,
  • "create_date": "string",
  • "domain": "string",
  • "id": 80,
  • "license_state": "string",
  • "region_id": 80,
  • "resources": {
    },
  • "subaccnt": 80,
  • "type": "string",
  • "uniq_id": "string",
  • "vcpu": 80,
  • "zone": {
    }
}

cloud/private/parent/list

Retrieve a paginated list of Private Cloud Parents on your 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).

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
}

cloud/private/parent/update

Update details about your parent. Currently on the domain of the server can be updated.

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.

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

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

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,
  • "config_description": "string",
  • "config_id": 80,
  • "create_date": "string",
  • "domain": "string",
  • "id": 80,
  • "license_state": "string",
  • "region_id": 80,
  • "resources": {
    },
  • "subaccnt": 80,
  • "type": "string",
  • "uniq_id": "string",
  • "vcpu": 80,
  • "zone": {
    }
}

Server

This section of the API provides convenience methods for managing cloud (Storm) servers in your account. All of the functionality here is also available in /server, but these methods strip away some of the generic boilerplate in /server that isn't necessary to manage cloud (Storm) servers.

cloud/server/clone

Clone a server. Returns the information about the newly created clone.

All of the optional fields are defaulted to the values on the original server if they aren't received. For cloning to a private parent, include the uniq_id of the parent server to be cloned to, along with the memory/diskspace/vcpu amounts (if different from the original).

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
new_ip6s
integer (NON_NEG_INT) ^\d+\z
Example: new_ip6s=12345

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

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

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

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

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

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

pool_ips
Array of strings <ipv4> (IPV4)
Example: pool_ips=172.0.0.1
uniq_id
string (SUBACCNT_UNIQ_ID) ^[A-HJ-NP-Z0-9]{6}\z

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

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

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

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

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

new_ips
integer (NON_NEG_INT) ^\d+\z
Default: 1
Example: new_ips=12345

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

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

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

pool6_ips
Array of strings (CIDRV6)
password
string (STORM_INSTANCE_PASSWORD) ^[a-zA-Z0-9~!\@#\$%^&*_+=`|\\(){}\[\]:;<>,.?/...

A password of at least 7 characters and up to 30 characters in length, containing no spaces. Must contain 3 of the 4 following classes: lowercase, uppercase, numbers and punctuation.

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

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

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,
  • "backup_enabled": true,
  • "backup_plan": "string",
  • "backup_quota": 12345,
  • "backup_size": 1.25,
  • "bandwidth_quota": 12345,
  • "config_description": "string",
  • "config_id": 80,
  • "create_date": "string",
  • "diskspace": 12345,
  • "domain": "example.com",
  • "ip": "172.0.0.1",
  • "ip_count": 80,
  • "manage_level": "string",
  • "memory": 12345,
  • "template": "string",
  • "template_description": "string",
  • "type": "string",
  • "uniq_id": "string",
  • "vcpu": 12345,
  • "zone": {
    }
}

cloud/server/create

Provision a new server. This fires off the build process, which does the actual provisioning of a new server on its parent. Each server consists of several distinct options:

config_id: the id of the server configuration you wish to use.  For a list
of available configs, see the cloud/config/list API method

template: templates are the LiquidWeb-provided server OS images.  For a list
of available templates, see the cloud/template/list API method

image_id: rather that provisioning a LiquidWeb template, you can specify
the id of a user-created image on your account.  Use the API method
cloud/image/list to find any existing images you have, or cloud/image/create
to create a new image from an existing server

ip_count: the number of IPs you wish the server to have.  This defaults to
1 IP, which is included in the base price.  Pricing for additional IPs can
be found using the product/details API method.

bandwidth_quota: the bandwidth plan you wish to use.  A quota of 0 indicates
that you want as-you-go, usage-based bandwidth charges, but may not be
permitted with all configs.  The remaining available quota options can be
found with the product/details API method.

backup_enabled: whether or not backups should be enabled.  Defaults to no.
If this is not set to 1, neither of the following two options will be used.

backup_plan: either 'quota' or 'daily', depending on whether you are
choosing a quota-based backup plan or just a specific number of days to be
backed up.

backup_quota: for a 'daily' plan, this indicates the number of days to back
up.  For a quota plan, this is the total number of GB to keep.  Available
options are found with the product/details API method .

public_ssh_key: optional public ssh key you want added to authorized_keys
on your new server.  This should be a valid public ssh key, e.g. the contents
of your id_rsa.pub file.

Beyond those options, we need the hostname of the server ('domain') and the root password you would like set on the server originally ('password').

More information about the returned data structure are found in the documentation for the cloud/server/details method.

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

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

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

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

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

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

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

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

password
string (STORM_INSTANCE_PASSWORD) ^[a-zA-Z0-9~!\@#\$%^&*_+=`|\\(){}\[\]:;<>,.?/...

A password of at least 7 characters and up to 30 characters in length, containing no spaces. Must contain 3 of the 4 following classes: lowercase, uppercase, numbers and punctuation.

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

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

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

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

template
string (WORD_) ^\w+\z

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

type
string (ACCOUNT_TYPE) ^[A-Za-z0-9.]{3,}\z

A valid subaccnt type descriptor (i.e. DS.W1, GUARD, etc), at least 3 chars long.

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

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

antivirus
string (STRING) ^.+\z

A string.

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

A single word, consisting of only letters and digits.

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

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

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

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

backup_enabled
boolean (BOOLEAN)

A boolean value (0 or 1).

public_ssh_key
string (MULTI_TYPE)

One of [SSH_KEY_PUBLIC] or [WORD_].

pool6_ips
Array of strings (CIDRV6)
ms_sql
string (STRING) ^.+\z

A string.

new_ips
integer (NON_NEG_INT) ^\d+\z
Default: 1
Example: new_ips=12345

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

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

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

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

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

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

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

pool_ips
Array of strings <ipv4> (IPV4)
Example: pool_ips=172.0.0.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,
  • "active": true,
  • "backup_enabled": true,
  • "backup_plan": "string",
  • "backup_quota": 12345,
  • "backup_size": 1.25,
  • "bandwidth_quota": 12345,
  • "config_description": "string",
  • "config_id": 80,
  • "create_date": "string",
  • "diskspace": 12345,
  • "domain": "example.com",
  • "ip": "172.0.0.1",
  • "ip_count": 80,
  • "manage_level": "string",
  • "memory": 12345,
  • "template": "string",
  • "template_description": "string",
  • "type": "string",
  • "uniq_id": "string",
  • "vcpu": 12345,
  • "zone": {
    }
}

cloud/server/destroy

Kills a server. It will refund for any remaining time that has been prepaid, charge any outstanding bandwidth charges, and then start the workflow to tear down the server.

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
{
  • "destroyed": "string"
}

cloud/server/details

Gets data relevant to a cloud (Storm) server.

Here's a rundown of what the returned fields mean:

accnt: your account number

active: a flag indicating whether the server has finished building

backup_enabled: whether or not backups are enabled

backup_plan: either 'quota' or 'daily', depending on which backup plan you
have enabled.  If backups are not enabled, this field is empty.

backup_quota: for a 'daily' plan, this indicates the number of days backed
up. For a quota plan, this is the total number of GB of backups kept for
this server. If backups are not enabled, this field is empty.

backup_size: the number of GB your current backups are using

bandwidth_quota: the number of GB of bandwidth included in your bill.
O indicates as-you-go usage-based bandwidth.

config_id: the id of the server configuration this server is using

config_description: a more descriptive name for the server configuration
assigned to this server. 'Storm 2GB', for example.

create_date: the date and time when the server was created

ip: the primary IP of the server

ip_count: the number of IPs the server has assigned to it

manage_level: 'self', 'core', or 'full', determined by which template you
chose when creating the server

    self: Includes support for hardware, network and virtualization layers.

    core: Includes complete support of the base operating system as well as
    Apache, Mysql and PHP. Proactive service restoration is provided.

    full: Includes cPanel + Fantastico as well complete support of base
    operating system and all cPanel services. Proactive service restoration
    is provided.

template: which OS image you have installed.  Even when you create a server
from an image, the original OS image is returned here.

template_description: a more informative description of the OS you are using
on this server.  'CentOS 5.5 64bit Core-Managed', for example.

uniq_id: the unique server identifier, made of 6 letters and numbers

zone: the zone in which your server resides.  This is not yet useful, but is
still provided as reference.  The zone identifiers may change.
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
{
  • "accnt": 0,
  • "active": true,
  • "backup_enabled": true,
  • "backup_plan": "string",
  • "backup_quota": 12345,
  • "backup_size": 1.25,
  • "bandwidth_quota": 12345,
  • "config_description": "string",
  • "config_id": 80,
  • "create_date": "string",
  • "diskspace": 12345,
  • "domain": "example.com",
  • "ip": "172.0.0.1",
  • "ip_count": 80,
  • "manage_level": "string",
  • "memory": 12345,
  • "template": "string",
  • "template_description": "string",
  • "type": "string",
  • "uniq_id": "string",
  • "vcpu": 12345,
  • "zone": {
    }
}

cloud/server/history

Get a list of notifications for a specific server. Information about the data returned can here be found in cloud/alerts/details

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.

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

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

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.

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
}

cloud/server/issbsoptimized

An instance uses more memory when using Cloud Block Storage volumes. Normal cloud (Storm) instances have enough pad for this to not be an issue, but bare-metal runs very tight. To work around this we can have a bare-metal instance use less memory so that the parent OS has more. We call this Cloud Block Storage optimization. This method returns a boolean flag 'is_optimized' which is true if the instance has been optimized and false otherwise.

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

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

subaccnt
integer (RELATION_ID) ^[1-9]\d*\z
Example: subaccnt=54321

A valid id number (a positive integer).

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
{
  • "is_optimized": true
}

cloud/server/list

Retrieve a paginated list of cloud (Storm) servers on your account. A more detailed description of what is returned can be found in the documentation for the cloud/server/details method.

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

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

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

parent
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
{
  • "item_count": 12345,
  • "item_total": 12345,
  • "items": [
    ],
  • "page_num": 80,
  • "page_size": 80,
  • "page_total": 80
}

cloud/server/reboot

Reboot a server. The 'force' flag will do a hard shutdown/boot of the server from the parent server.

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.

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

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

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

cloud/server/resize

Resize a server to a new configuration. Available config_ids can be found in cloud/config/list.

You will be billed for the prorated difference of the price of the new configuration compared to the price of your old configuration. The difference will be refunded or charged at your next billing date.

A server resize cannot cross zones.

When resizing to a larger configuration, the filesystem resize operation can be skipped by passing the 'skip_fs_resize' option. In this case, the storage associated with the new configuration is allocated, but not available immediately. The filesystem resize should be scheduled with the support team.

Skipping the filesystem resize is only possible when moving to a larger configuration. This option has no effect if moving to the same or smaller configuration.

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

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

diskspace
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: diskspace=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.

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

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

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

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

skip_fs_resize
boolean (BOOLEAN)

A boolean value (0 or 1).

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

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

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,
  • "backup_enabled": true,
  • "backup_plan": "string",
  • "backup_quota": 12345,
  • "backup_size": 1.25,
  • "bandwidth_quota": 12345,
  • "config_description": "string",
  • "config_id": 80,
  • "create_date": "string",
  • "diskspace": 12345,
  • "domain": "example.com",
  • "ip": "172.0.0.1",
  • "ip_count": 80,
  • "manage_level": "string",
  • "memory": 12345,
  • "template": "string",
  • "template_description": "string",
  • "type": "string",
  • "uniq_id": "string",
  • "vcpu": 12345,
  • "zone": {
    }
}

cloud/server/resizeplan

Use this method to determine if currently resizing your server to your chosen config_id would result in any downtime.

If there is no inventory available for the config_id, an exception will be raised.

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

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

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

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

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

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

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

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

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

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
{
  • "diskDifference": 12345,
  • "memoryDifference": 12345,
  • "rebootRequired": true,
  • "vcpuDifference": 12345
}

cloud/server/setsbsoptimized

Start the appropriate workflow to turn Cloud Block Storage optimization on or off. If the desired value that you pass is the same as the current state of your instance, this method is a no-op.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
value
boolean (BOOLEAN)

A boolean value (0 or 1).

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

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

subaccnt
integer (RELATION_ID) ^[1-9]\d*\z
Example: subaccnt=54321

A valid id number (a positive integer).

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
{
  • "updated": "string"
}

cloud/server/shutdown

Stop a server. The 'force' flag will do a hard stop of the server from the parent server. Otherwise, it will issue a halt command to the server and shutdown normally.

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.

force
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
{
  • "shutdown": "string"
}

cloud/server/start

Boot a server. If the server is already running, this will do nothing.

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
{
  • "started": "string"
}

cloud/server/status

Gets the current status of a server, in relation to what processes are being run on its behalf.

The list of available statuses at this time are:

Building
Cloning
Resizing
Moving
Booting
Stopping
Restarting
Rebooting
Shutting Down
Restoring Backup
Creating Image
Deleting Image
Restoring Image
Re-Imaging
Updating Firewall
Updating Network
Adding IPs
Removing IP
Destroying

If nothing is currently running, only the 'status' field will be returned with one of the following statuses:

Failed
Provisioning
Running
Shutdown
Stopped
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
{
  • "detailed_status": "string",
  • "progress": 1.25,
  • "running": [
    ],
  • "status": "string"
}

cloud/server/update

Update details about your server, including the backup and bandwidth plans, and the hostname ('domain') we have on file.

Updating the 'domain' field will not change the actual hostname on the server. It merely updates what our records show.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
backup_enabled
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.

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

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

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

A single word, consisting of only letters and digits.

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

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

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

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

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,
  • "backup_enabled": true,
  • "backup_plan": "string",
  • "backup_quota": 12345,
  • "backup_size": 1.25,
  • "bandwidth_quota": 12345,
  • "config_description": "string",
  • "config_id": 80,
  • "create_date": "string",
  • "diskspace": 12345,
  • "domain": "example.com",
  • "ip": "172.0.0.1",
  • "ip_count": 80,
  • "manage_level": "string",
  • "memory": 12345,
  • "template": "string",
  • "template_description": "string",
  • "type": "string",
  • "uniq_id": "string",
  • "vcpu": 12345,
  • "zone": {
    }
}

Template

Templates are OS images created and maintained by LiquidWeb. This section of the API allows remote interaction with those images.

cloud/template/details

Get information about a specific template. You can query details about inactive templates because backups, existing servers, and images might be tied to one, but you cannot provision to or restore an inactive template. You can, however, restore from a deprecated template.

Here's a rundown of what those fields mean:

active: a flag indicating whether the template is currently active.  You can
only create or reimage servers to active templates.

deprecated: a flag indicating whether the template has been deprecated.
This means it can't be used for new creates, but can be used to restore
from backups or images.

description: the descriptive OS template name

id: the id of the template

manage_level: 'self', 'core', or 'full', determined by which template you
chose when creating the server

    self: Includes support for hardware, network and virtualization layers.

    core: Includes complete support of the base operating system as well as
    Apache, Mysql and PHP. Proactive service restoration is provided.

    full: Includes cPanel + Fantastico as well complete support of base
    operating system and all cPanel services. Proactive service restoration
    is provided.

name: a unique identifier for the template, used in methods like
server/create

os: an internal OS identifier.  There can be multiple templates that have
the same OS, but differ in other ways (like management level).
Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
id
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: id=80

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

template
string (TEXT_GENERAL)

A string permitting tabs, carriage returns and newlines

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

Content type
application/json
Example
{
  • "deprecated": true,
  • "description": "string",
  • "id": 80,
  • "manage_level": "string",
  • "name": "string",
  • "os": "string",
  • "zone_availability": { }
}

cloud/template/list

Get a list of useable templates. More information about the fields returned can be found in the documenation for server/template/details

This method returns templates that are currently active, including deprecated templates which may not be used for new instances but may be associated with existing servers or backups.

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

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
}

cloud/template/restore

Re-images a server with the template requested. If the 'force' flag is passed it will rebuild the filesystem on the server before restoring. This option is not usually needed, but if regular restores are failing, it can fix some scenarios.

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

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

template
string (TEXT_GENERAL)

A string permitting tabs, carriage returns and newlines

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

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

force
boolean (BOOLEAN)

A boolean value (0 or 1).

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
{
  • "reimaged": "string"
}

Contact

This section contains methods to update and manipulate contact data.

contact/create

Create a new contact

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
id
integer (RELATION_ID) ^[1-9]\d*\z
Example: id=54321

A valid id number (a positive integer).

updated_date
string (TIMESTAMP) ^\d{4}-\d{1,2}-\d{1,2} \d{1,2}:\d{1,2}:\d{1,2...

A valid date and time in YYYY-MM-DD HH:MM:SS-TZ format.

contact_role
any
Enum: "individual" "organization"
tax_exempt
boolean (BOOLEAN)

A boolean value (0 or 1).

Array of objects
validated
boolean (BOOLEAN)

A boolean value (0 or 1).

mname
string (NAME_STRICT) ^(?i)[^[:cntrl:]<>{}\[\]]{1,100}\z

A valid name, up to 100 characters in length.

contact_role_id
integer (RELATION_ID) ^[1-9]\d*\z
Example: contact_role_id=54321

A valid id number (a positive integer).

time_zone
string (TIME_ZONE) ^(?:\w+/)*\w+

A valid timezone with a word, a forward-slash, and another word (e.g. US/Eastern) and any number of trailing forward slashes and words (e.g. America/Argentina/BuenosAires)

contact
string (TEXT_GENERAL)

A string permitting tabs, carriage returns and newlines

tax_id
string (TAX_ID) ^(?i)[a-z0-9 #_:-]{2,40}\z

A valid tax or tax exemption id.

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

A valid state or province.

fname
string (NAME_STRICT) ^(?i)[^[:cntrl:]<>{}\[\]]{1,100}\z

A valid name, up to 100 characters in length.

address2
string (STREET_ADDRESS_STRICT) ^(?i)[^[:cntrl:]<>{}\[\]]{2,150}\z

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

type
any
Value: "invoice"
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

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

address
string (STREET_ADDRESS_STRICT) ^(?i)[^[:cntrl:]<>{}\[\]]{2,150}\z

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

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

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

lname
string (NAME_STRICT) ^(?i)[^[:cntrl:]<>{}\[\]]{1,100}\z

A valid name, up to 100 characters in length.

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

A valid country.

tax_exempt_id
string (TAX_ID) ^(?i)[a-z0-9 #_:-]{2,40}\z

A valid tax or tax exemption id.

title
string (LAXWORDS) ^[\w -]*\z

A string consisting of only letters, digits, hyphens, spaces, and underscores.

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

A valid postal code.

organization
string (ORGNAME_STRICT) ^(?i)[^[:cntrl:]<>{}\[\]]{2,100}\z

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

city
string (CITY_STRICT) ^(?i)[^[:cntrl:]<>{}\[\]]{2,80}\z

A valid city name.

Array of objects
foreign_tax_type
string (WORD) ^(?i)[a-z0-9]*\z

A single word, consisting of only letters and digits.

Array of objects
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",
  • "contact": "string",
  • "contact_role": "individual",
  • "contact_role_id": 54321,
  • "country": "string",
  • "emails": [
    ],
  • "fname": "string",
  • "foreign_tax_type": "string",
  • "id": 54321,
  • "lname": "string",
  • "mname": "string",
  • "organization": "string",
  • "phones": [
    ],
  • "postal_code": "string",
  • "social": [
    ],
  • "state": "string",
  • "tax_exempt": true,
  • "tax_exempt_id": "string",
  • "tax_exempt_reason": "string",
  • "tax_id": "string",
  • "time_zone": "string",
  • "title": "string",
  • "type": "invoice",
  • "updated_date": "string",
  • "validated": true
}

contact/details

show the details of one specific contact

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
id
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: id=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.

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

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

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",
  • "contact": "string",
  • "contact_role": "individual",
  • "contact_role_id": 54321,
  • "country": "string",
  • "emails": [
    ],
  • "fname": "string",
  • "foreign_tax_type": "string",
  • "id": 54321,
  • "lname": "string",
  • "mname": "string",
  • "organization": "string",
  • "phones": [
    ],
  • "postal_code": "string",
  • "social": [
    ],
  • "state": "string",
  • "tax_exempt": true,
  • "tax_exempt_id": "string",
  • "tax_exempt_reason": "string",
  • "tax_id": "string",
  • "time_zone": "string",
  • "title": "string",
  • "type": "invoice",
  • "updated_date": "string",
  • "validated": true
}

contact/list

list all contacts by account

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_num
integer (POSITIVE_INT) ^[1-9]\d*\z
Default: 1
Example: page_num=80

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

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

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

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

A valid phone number.

sort_order
any
Enum: "asc" "desc" "ASC" "DESC"
mname
string (LINE) ^[^[:cntrl:]]*\z

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

order_by
string (SQL_ORDER_BY)

A valid SQL order by clause (cannot contain any subqueries).

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

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

time_zone
string (TIME_ZONE) ^(?:\w+/)*\w+

A valid timezone with a word, a forward-slash, and another word (e.g. US/Eastern) and any number of trailing forward slashes and words (e.g. America/Argentina/BuenosAires)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ipaddr
string (IP)

A valid IP address (v4 or v6)

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

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

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
}

contact/update

update a contact given replacement fields for current fields.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
tax_exempt_reason
string (LINE) ^[^[:cntrl:]]*\z

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

address
string (STREET_ADDRESS_STRICT) ^(?i)[^[:cntrl:]<>{}\[\]]{2,150}\z

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

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

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

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

A valid postal code.

title
string (LAXWORDS) ^[\w -]*\z

A string consisting of only letters, digits, hyphens, spaces, and underscores.

tax_exempt_id
string (TAX_ID) ^(?i)[a-z0-9 #_:-]{2,40}\z

A valid tax or tax exemption id.

lname
string (NAME_STRICT) ^(?i)[^[:cntrl:]<>{}\[\]]{1,100}\z

A valid name, up to 100 characters in length.

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

A valid country.

city
string (CITY_STRICT) ^(?i)[^[:cntrl:]<>{}\[\]]{2,80}\z

A valid city name.

organization
string (ORGNAME_STRICT) ^(?i)[^[:cntrl:]<>{}\[\]]{2,100}\z

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

Array of objects
foreign_tax_type
string (WORD) ^(?i)[a-z0-9]*\z

A single word, consisting of only letters and digits.

Array of objects
tax_exempt
boolean (BOOLEAN)

A boolean value (0 or 1).

updated_date
string (TIMESTAMP) ^\d{4}-\d{1,2}-\d{1,2} \d{1,2}:\d{1,2}:\d{1,2...

A valid date and time in YYYY-MM-DD HH:MM:SS-TZ format.

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

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

Array of objects
mname
string (NAME_STRICT) ^(?i)[^[:cntrl:]<>{}\[\]]{1,100}\z

A valid name, up to 100 characters in length.

validated
boolean (BOOLEAN)

A boolean value (0 or 1).

address2
string (STREET_ADDRESS_STRICT) ^(?i)[^[:cntrl:]<>{}\[\]]{2,150}\z

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

fname
string (NAME_STRICT) ^(?i)[^[:cntrl:]<>{}\[\]]{1,100}\z

A valid name, up to 100 characters in length.

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

A valid state or province.

tax_id
string (TAX_ID) ^(?i)[a-z0-9 #_:-]{2,40}\z

A valid tax or tax exemption id.

time_zone
string (TIME_ZONE) ^(?:\w+/)*\w+

A valid timezone with a word, a forward-slash, and another word (e.g. US/Eastern) and any number of trailing forward slashes and words (e.g. America/Argentina/BuenosAires)

contact
string (TEXT_GENERAL)

A string permitting tabs, carriage returns and newlines

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",
  • "contact": "string",
  • "contact_role": "individual",
  • "contact_role_id": 54321,
  • "country": "string",
  • "emails": [
    ],
  • "fname": "string",
  • "foreign_tax_type": "string",
  • "id": 54321,
  • "lname": "string",
  • "mname": "string",
  • "organization": "string",
  • "phones": [
    ],
  • "postal_code": "string",
  • "social": [
    ],
  • "state": "string",
  • "tax_exempt": true,
  • "tax_exempt_id": "string",
  • "tax_exempt_reason": "string",
  • "tax_id": "string",
  • "time_zone": "string",
  • "title": "string",
  • "type": "invoice",
  • "updated_date": "string",
  • "validated": true
}

Domain

This section of the API allows for working with domain related assets

domain/list

Returns a paginated list of domain related assets

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
object
types
Array of any
Default: "dns&types=dreg&types=ssl"
Items Enum: "dns" "dreg" "ssl"
domain
string (MULTI_TYPE)

One of [DOMAIN_FRAGMENT] or [DOMAIN_FULL].

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

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

autorenew
boolean (BOOLEAN)

A boolean value (0 or 1).

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

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
}

domain/related

Returns structured data of domain assets whose domain relates to the given domain (subdomains and other tlds). When explaining below, the terms sub, base and tld will be used. If the domain arg is whatever.myspecialdomain.com, the breakdown would be

sub: whatever base: myspecialdomain tld: com

When talking about parent_domain we are referring to base.tld (myspecialdomain.com)

In the returned structure

parent_domain: condition: only returned if domain arg has a sub and parent_domain exists as a domain related asset contains: base.tld

tlds: condition: only returned if the domain arg does not contain a sub (is a parent_domain itself) contains: domains whose base is the same as the domain arg

sub_domains: condition: always returned contains: domains which have subs and whose parent_domain is the same as the domain arg

All things that are returned should exist as assets

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

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

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

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

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

Content type
application/json
Example
{
  • "parent_domain": "example.com",
  • "sub_domains": [
    ],
  • "tlds": [
    ]
}

Services

This section of the API allows for working with services for domains

domain/services/summary

Returns a summary of domain services (BusinessEmail and CloudFlare)

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

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

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

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

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

Content type
application/json
Example
{
  • "business_email": {
    },
  • "cloudflare": {
    }
}

Bandwidth

This section of the api provides methods for querying in the bandwidth activity of a server.

monitoring/bandwidth/graph

Get a bandwidth usage graph for a server. The image is returned as a base64 encoded blob.

'frequency' is the duration of the graph you wish to see. For example, if frequency is daily, the bandwidth usage for the last day would be graphed. The default is to get the last month, but the following options are available:

'daily', 'weekly', 'monthly', 'yearly'

Examples:

Perl:

my $graph = $api->request('monitoring/bandwidth/graph', { uniq_id => ABC123 });

print "Content-type: $graph->{content_type}\n\n"; print MIME::Base64::decode_base64($graph->{content});

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.

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

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

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

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

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

small
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
{
  • "content": "string",
  • "content_type": "string"
}

monitoring/bandwidth/stats

Get bandwidth usage stats for a server.

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
{
  • "actual": {
    },
  • "averages": {
    },
  • "cost": {
    },
  • "domain": "example.com",
  • "pricing": {
    },
  • "projected": {
    }
}

Load

This section contains methods for quering the load and usage statistics of a server.

monitoring/load/graph

Get a load graph for a server as a base64 encoded blob.

'stat' is the load statistic to be graphed. Available options are:

'load1'      - 1 minute load average
'load5'      - 5 minute load average
'load15'     - 15 minute load average
'rproc'      - running process count
'tproc'      - total process count
'pmem'       - physical memory usage
'smem'       - swap (virtual) memory usage
'diskroot'   - /root volume usage
'diskbackup' - /backup volume usage
'diskhome'   - /home volume usage
'disktmp'    - /tmp volume usage
'diskusr'    - /usr volume usage
'diskvar'    - /var volume usage

'duration' is the duration of data you wish to graph. The default is to get the last day, but the following options are available:

'6hour', '12hour', 'day', '3day', 'week', '2week'

Examples:

Perl:

my $graph = $api->request('monitoring/load/graph', { stat => 'load1', uniq_id => 'ABCD1234' });

print "Content-type: $graph->{content_type}\n\n"; print MIME::Base64::decode_base64($graph->{content});

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

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

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

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

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

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

compact
boolean (BOOLEAN)

A boolean value (0 or 1).

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

A single word, consisting of only letters and digits.

duration
string (WORD) ^(?i)[a-z0-9]*\z
Default: "day"

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
{
  • "content": "string",
  • "content_type": "string"
}

monitoring/load/stats

Get load stats for a server. Memory is returned in units of MB, whereas disk usage is in terms of GB. Values can be returned as 'N/A' if there was no data collected or the item in question is not something on the server.

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
{
  • "disk": {
    },
  • "domain": "example.com",
  • "loadavg": {
    },
  • "memory": {
    },
  • "proc": {
    },
  • "uptime": "string"
}

Services

This section of the API allows for remotely querying service status data for a server, as well as managing monitoring settings.

monitoring/services/get

Get the current monitoring settings for a server.

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
{
  • "can_monitor": [
    ],
  • "enabled": true,
  • "services": [
    ],
  • "uniq_id": "string",
  • "unmonitored": true
}

monitoring/services/status

Get the current service status for each monitored service on a server.

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
{
  • "DYNAMIC[WORD]": "string"
}

DNS/Domain

This section of the API allows for listing registered domains and renewing those domains.

network/dns/domain/autorenew

Turns autorenewal On or Off.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
subaccnt
integer (RELATION_ID) ^[1-9]\d*\z
Example: subaccnt=54321

A valid id number (a positive integer).

allow
boolean (BOOLEAN)

A boolean value (0 or 1).

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
{
  • "allow": true,
  • "domain": "example.com"
}

network/dns/domain/details

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)

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

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

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
{
  • "autorenew": true,
  • "autorenew_only": true,
  • "autorenew_value": "On",
  • "domain": "example.com",
  • "duration": 1,
  • "expiration": "string",
  • "has_privacy": true,
  • "is_expired": true,
  • "is_renewable": true,
  • "is_rgp": true,
  • "is_transfer": true,
  • "privacy": "On",
  • "privacy_allowed": true,
  • "redemption_order_id": "string",
  • "redemption_price": "string",
  • "renewal_max_years": 80,
  • "renewal_price": "string",
  • "uniq_id": "string"
}

network/dns/domain/disableprivacy

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
{
  • "success": true
}

network/dns/domain/enableprivacy

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
{
  • "success": true
}

network/dns/domain/list

Returns the list of domain registrations for a given account.

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

domain
string (DOMAIN_FRAGMENT)
Example: domain=dns.example

A fragment of a valid domain name, suitable for partial domain searching

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

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

object
transfers
boolean (BOOLEAN)

A boolean value (0 or 1).

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.

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

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

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
}

network/dns/domain/multiregister

Register multimple domain, up to five, at the same time.

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

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

Array of objects
Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

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

network/dns/domain/purchaseprivacy

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
{
  • "method": "string",
  • "success": true
}

network/dns/domain/register

Create a domain registration request.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
object
reseller
boolean (BOOLEAN)

A boolean value (0 or 1).

lwtech
boolean (BOOLEAN)

A boolean value (0 or 1).

nameServers
Array of strings <hostname> (DOMAIN_FULL)
Example: nameServers=example.com
domain
string <hostname> (DOMAIN_FULL)
Example: domain=example.com

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

duration
any
Default: 1
Enum: 1 2 3 4 5 6 7 8 9 10
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

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

privacy
boolean (BOOLEAN)

A boolean value (0 or 1).

autoRenew
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
{
  • "autorenew": true,
  • "autorenew_only": true,
  • "autorenew_value": "On",
  • "domain": "example.com",
  • "duration": 1,
  • "expiration": "string",
  • "has_privacy": true,
  • "is_expired": true,
  • "is_renewable": true,
  • "is_rgp": true,
  • "is_transfer": true,
  • "privacy": "On",
  • "privacy_allowed": true,
  • "redemption_order_id": "string",
  • "redemption_price": "string",
  • "renewal_max_years": 80,
  • "renewal_price": "string",
  • "uniq_id": "string"
}

network/dns/domain/registrationdetails

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
domain
string (MULTI_TYPE)

One of [DNS_LABEL] or [DOMAIN_FULL].

skip_suggested_domains
boolean (BOOL)

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
{
  • "available": true,
  • "domain": "example.com",
  • "enabled": true,
  • "extended_attributes": [
    ],
  • "lax": true,
  • "lockable": true,
  • "max_period": 1,
  • "min_period": 1,
  • "price": "string",
  • "real_time": true,
  • "registerable": true,
  • "suggested": [
    ]
}

network/dns/domain/renew

Renews a domain.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
duration
any
Default: 1
Enum: 1 2 3 4 5 6 7 8 9 10
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

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

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

autoRenew
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
{
  • "autorenew": true,
  • "autorenew_only": true,
  • "autorenew_value": "On",
  • "domain": "example.com",
  • "duration": 1,
  • "expiration": "string",
  • "has_privacy": true,
  • "is_expired": true,
  • "is_renewable": true,
  • "is_rgp": true,
  • "is_transfer": true,
  • "privacy": "On",
  • "privacy_allowed": true,
  • "redemption_order_id": "string",
  • "redemption_price": "string",
  • "renewal_max_years": 80,
  • "renewal_price": "string",
  • "uniq_id": "string"
}

network/dns/domain/tlddetails

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

One of [DOMAIN_FULL] or [ARRAY[DOMAIN_FULL]].

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

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

DNS/Domain/Contact

This section of the API allows for working with the contact information for a given domain.

network/dns/domain/contact/list

Get contacts for the given domain.

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.

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
{
  • "contacts": [
    ]
}

network/dns/domain/contact/update

This method can be used to update contact information for a domain at eNom. Limited to REGISTRANT, TECH, ADMIN types.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
use_LW_for_tech_contact
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.

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

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

sync_all_with_billing
boolean (BOOLEAN)

A boolean value (0 or 1).

object
object
Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

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

DNS/Domain/Nameserver

This section of the API allows for working with the name server information for a given domain.

network/dns/domain/nameserver/assign

Change which name servers are assigned to a domain.

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

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

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

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

ns2
string <hostname> (DOMAIN_FULL)
Example: ns2=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.

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

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

network/dns/domain/nameserver/delete

Remove a nameserver from a domain.

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.

ns
string <hostname> (DOMAIN_ANY)
Example: ns=example.com

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

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
{
  • "success": true
}

network/dns/domain/nameserver/listassigned

List assigned name servers for a domain.

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.

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
{
  • "results": [
    ]
}

network/dns/domain/nameserver/listregistered

List registered name servers for a domain.

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
{
  • "results": [
    ]
}

network/dns/domain/nameserver/register

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

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

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

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

ip
string <ipv4> (IPV4)
Example: ip=172.0.0.1

An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)

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
{
  • "id": 54321,
  • "ip": "172.0.0.1",
  • "name_server": "example.com",
  • "uniq_id": "string"
}

network/dns/domain/nameserver/updateregisteredip

This method can be used to update the name server for a domain,

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

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

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

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

newip
string <ipv4> (IPV4)
Example: newip=172.0.0.1

An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)

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
{
  • "id": 54321,
  • "ip": "172.0.0.1",
  • "name_server": "example.com",
  • "uniq_id": "string"
}

DNS/Domain/Transfer

This section of the API allows for working with transfers for a given domain.

network/dns/domain/transfer/canceltransfer

Cancel a given transfer, if possible.

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
{
  • "success": true
}

network/dns/domain/transfer/createincoming

Create an incoming domain transfer.

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

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

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

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

Content type
application/json
Example
{
  • "created_date": "string",
  • "domain": "example.com",
  • "id": 54321,
  • "is_cancellable": true,
  • "is_complete": true,
  • "registrar_detail_status_description": "string",
  • "registrar_detail_status_id": 80,
  • "registrar_order_id": 12345,
  • "registrar_status_id": 80,
  • "transfer_type": "incoming",
  • "uniq_id": "string"
}

network/dns/domain/transfer/createoutgoing

Create an outgoing domain transfer.

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
{
  • "created_date": "string",
  • "domain": "example.com",
  • "id": 54321,
  • "is_cancellable": true,
  • "is_complete": true,
  • "registrar_detail_status_description": "string",
  • "registrar_detail_status_id": 80,
  • "registrar_order_id": 12345,
  • "registrar_status_id": 80,
  • "transfer_type": "incoming",
  • "uniq_id": "string"
}

network/dns/domain/transfer/delete

Delete a transfer record for the given domain.

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
{
  • "success": true
}

network/dns/domain/transfer/details

Delete a transfer record for the given domain.

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
{
  • "created_date": "string",
  • "domain": "example.com",
  • "id": 54321,
  • "is_cancellable": true,
  • "is_complete": true,
  • "registrar_detail_status_description": "string",
  • "registrar_detail_status_id": 80,
  • "registrar_order_id": 12345,
  • "registrar_status_id": 80,
  • "transfer_type": "incoming",
  • "uniq_id": "string"
}

network/dns/domain/transfer/list

List a transfer records for the given account.

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

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

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.

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
}

network/dns/domain/transfer/resendemail

Resend the authorization email for an incoming transfer

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
{
  • "success": true
}

network/dns/domain/transfer/sendeppcode

Sends the EPP code for a given domain

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
{
  • "success": true
}

DNS/Record

Each DNS zone contains multiple Resource Records, which are the guts of DNS. Each record can point an domain name to an IP, a subdomain to another domain, etc.

This section of the API allows interaction with all the various
Resource Records in your zones.

network/dns/record/create

This method is used to add new resource records (RRs) to a zone.

The returned data will be an associative array of the fields of the record, and will include any parsed rdata fields in that associateve array, such as the priority and exchange fields of an MX record.

In the v1 api, the prio field is considered seperate from rdata, and should be specified seperately, but in the bleed version and future numbered versions of the api, the prio field is considered part of the record data, and should be included there if appropriate for the record.

Fields: zone_id: The id of the zone that you are creating the record in. zone: The name of the zone that you are creating the record in. name: The name field of the record itself. type: The type of the record, which must a valid DNS record type. ttl: The Time To Live for the record. prio: The priority field for the record. This field applies to MX and SRV records. rdata: The Record Data associated with this DNS record. The exact contents are dependent on record type.

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

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

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

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

name
string (TEXT_GENERAL)

A string permitting tabs, carriage returns and newlines

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

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

rdata
string (TEXT_GENERAL)

A string permitting tabs, carriage returns and newlines

type
string (RR_TYPE)

A valid DNS resource record type

zone
string (MULTI_TYPE)

One of [DNS_REVERSE_ZONE] or [DNS_ZONE].

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

Content type
application/json
Example
{
  • "adminEmail": "string",
  • "created": "string",
  • "exchange": "example.com",
  • "expiry": 12345,
  • "fullData": "string",
  • "id": 80,
  • "last_updated": "string",
  • "minimum": 12345,
  • "name": "string",
  • "nameserver": "string",
  • "port": 80,
  • "prio": 12345,
  • "rdata": "string",
  • "refreshInterval": 12345,
  • "regionOverrides": [
    ],
  • "retry": 12345,
  • "serial": 80,
  • "target": "example.com",
  • "ttl": 80,
  • "type": "NS",
  • "weight": 12345,
  • "zone_id": 80
}

network/dns/record/delete

This method is used to delete resource records (RRs) from a zone file It returns the 'deleted' field, whose value is the records id field.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
id
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: id=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.

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

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

network/dns/record/details

Retrieve details about a particular resource record.

The returned structure is an associative array of the details of the record, with additional fields added to represent the derived meaning of the rdata field.

For example, an MX record will have a field present for the exchange that it points to, and an SRV record will have fields for weight, port and target.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
id
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: id=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.

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

Content type
application/json
Example
{
  • "adminEmail": "string",
  • "created": "string",
  • "exchange": "example.com",
  • "expiry": 12345,
  • "fullData": "string",
  • "id": 80,
  • "last_updated": "string",
  • "minimum": 12345,
  • "name": "string",
  • "nameserver": "string",
  • "port": 80,
  • "prio": 12345,
  • "rdata": "string",
  • "refreshInterval": 12345,
  • "regionOverrides": [
    ],
  • "retry": 12345,
  • "serial": 80,
  • "target": "example.com",
  • "ttl": 80,
  • "type": "NS",
  • "weight": 12345,
  • "zone_id": 80
}

network/dns/record/list

This method is used to get resource records (RRs) from a zone file. Each entry in the 'items' array referrs to one of the records in the zone. The details of these entries are further described in the 'details' method.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
zone
string (MULTI_TYPE)

One of [DNS_ZONE] or [DNS_REVERSE_ZONE].

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

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

zone_id
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: zone_id=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
}

network/dns/record/multicreateandupdate

This method is used to create and update multiple resource records (RRs) simultaneously.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
Array of objects
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
{
  • "result": [
    ]
}

network/dns/record/update

This method is used to update resource records (RRs) in a zone.

For details on the return structure, input field explanation, and interversion compatibility caveats, please referr to the documentation of the 'create' method.

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

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

name
string (TEXT_GENERAL)

A string permitting tabs, carriage returns and newlines

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

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
{
  • "adminEmail": "string",
  • "created": "string",
  • "exchange": "example.com",
  • "expiry": 12345,
  • "fullData": "string",
  • "id": 80,
  • "last_updated": "string",
  • "minimum": 12345,
  • "name": "string",
  • "nameserver": "string",
  • "port": 80,
  • "prio": 12345,
  • "rdata": "string",
  • "refreshInterval": 12345,
  • "regionOverrides": [
    ],
  • "retry": 12345,
  • "serial": 80,
  • "target": "example.com",
  • "ttl": 80,
  • "type": "NS",
  • "weight": 12345,
  • "zone_id": 80
}

DNS/Reverse

Normally with DNS, you look up an IP address with a domain name. In the case of Reverse DNS, you look up a domain name from an IP address. Many technologies use this as a means of validating requests are coming from where they say they are.

This section of the API allows you to set up, remove, and query Reverse
DNS information for your IPs.

network/dns/reverse/assignableips

Get a list of IPs available for assignment.

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
{
  • "items": [
    ]
}

network/dns/reverse/delete

This method is used to remove reverse DNS records.

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

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

ip
string <ipv4> (IPV4)
Example: ip=172.0.0.1

An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)

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
{
  • "deleted": "172.0.0.1"
}

network/dns/reverse/update

Updates a ptr record.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
ip
string <ipv4> (IPV4)
Example: ip=172.0.0.1

An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)

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

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

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
{
  • "DYNAMIC[IPV4|IP_RANGE]": "example.com"
}

DNS/Zone

DNS allows you to point domain names to IP addresses. Each domain name is represented by a DNS zone, which in turns can contain several records of varying types. For more information about the generals of DNS, refer to Wikipedia or some other resource.

This section of the API contains methods for creating and deleting
zones from our DNS system, as well as getting information about what
zones we are currently serving for you.

network/dns/zone/bulkupdatettl

Update all resource records in a zone with the same TTL.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
name
string (DNS_ZONE)
Example: name=dns.example

A valid forward DNS Zone name.

ttl
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: ttl=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.

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
{
  • "records": [
    ]
}

network/dns/zone/create

Add a new DNS zone.

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

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

live_domain
boolean (BOOLEAN)

A boolean value (0 or 1).

region_support
boolean (BOOLEAN)

A boolean value (0 or 1).

object
add_pbe_records
boolean (BOOLEAN)

A boolean value (0 or 1).

no_extra
boolean (BOOLEAN)

A boolean value (0 or 1).

cloudsite
boolean (BOOLEAN)

A boolean value (0 or 1).

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

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

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,
  • "delegation": [
    ],
  • "delegation_checked": "string",
  • "delegation_status": "string",
  • "id": 80,
  • "master": "172.0.0.1",
  • "name": "example.com",
  • "notified_serial": 80,
  • "region_support": true,
  • "type": "string"
}

network/dns/zone/delegation

This method can be used to check if a DNS zone is properly delegated to our nameservers.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
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).

name
string <hostname> (DNS_NAME)
Example: name=example.com

A valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters)

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

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

network/dns/zone/delete

Remove a DNS zone.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
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).

name
string (DNS_ZONE)
Example: name=dns.example

A valid forward DNS Zone name.

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

Content type
application/json
Example
{
  • "deleted": "example.com"
}

network/dns/zone/details

Retrieve details on a particular zone served by our DNS servers.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
name
string (DNS_ZONE)
Example: name=dns.example

A valid forward DNS Zone name.

alsowith
Array of any
Items Value: "delegation"
id
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: id=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.

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,
  • "delegation": [
    ],
  • "delegation_checked": "string",
  • "delegation_status": "string",
  • "id": 80,
  • "master": "172.0.0.1",
  • "name": "example.com",
  • "notified_serial": 80,
  • "region_support": true,
  • "type": "string"
}

network/dns/zone/formatasbind

Formats the Zone and Records in BIND Format

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
id
integer (RELATION_ID) ^[1-9]\d*\z
Example: id=54321

A valid id number (a positive integer).

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

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

name
string (DNS_ZONE)
Example: name=dns.example

A valid forward DNS Zone name.

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

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

network/dns/zone/importcpanelzone

Given a domain and a uniq_id, imports domain information from cPanel and creates requisite records.

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.

domain
string (DNS_ZONE)
Example: domain=dns.example

A valid forward DNS Zone name.

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,
  • "delegation": [
    ],
  • "delegation_checked": "string",
  • "delegation_status": "string",
  • "id": 80,
  • "master": "172.0.0.1",
  • "name": "example.com",
  • "notified_serial": 80,
  • "region_support": true,
  • "subaccnt": 54321,
  • "type": "string",
  • "uniq_id": "string"
}

network/dns/zone/importzonefile

Upload a DNS zone file and add the zone.

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

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

zonefile
string (TEXT_GENERAL)

A string permitting tabs, carriage returns and newlines

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

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

network/dns/zone/list

Retrieve a list of zones that are served by our DNS servers for your 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).

delegation_status
any
Enum: "CORRECT" "NXDOMAIN" "BAD_NAMESERVERS" "SERVFAIL" "UNKNOWN"
accnt
integer (ACCOUNT_NUMBER) ^\d{1,8}\z

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

domain
string (DOMAIN_FRAGMENT)
Example: domain=dns.example

A fragment of a valid domain name, suitable for partial domain searching

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
}

network/dns/zone/parkableips

Returns a list of IPs that are valid destinations for A records to be created at the time of creating the zone.

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
{
  • "items": [
    ]
}

network/dns/zone/summary

Retrieve a summary on a particular DNS zone.

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

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

name
string (DNS_ZONE)
Example: name=dns.example

A valid forward DNS Zone name.

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,
  • "delegation": [
    ],
  • "delegation_checked": "string",
  • "delegation_status": "string",
  • "id": 80,
  • "master": "172.0.0.1",
  • "name": "example.com",
  • "notified_serial": 80,
  • "records": {
    },
  • "region_support": true,
  • "type": "string"
}

network/dns/zone/update

Update the zone features.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
id
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: id=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.

name
string (DNS_ZONE)
Example: name=dns.example

A valid forward DNS Zone name.

DNSRegionSupport
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
{
  • "active": true,
  • "delegation": [
    ],
  • "delegation_checked": "string",
  • "delegation_status": "string",
  • "id": 80,
  • "master": "172.0.0.1",
  • "name": "example.com",
  • "notified_serial": 80,
  • "region_support": true,
  • "type": "string"
}

DNS/Zone/History

API interface for accessing DNS Zone History, which is a JSON structured snapshot of a zone and it's associated records that is captured prior to any change being made to a resource record (MX, CNAME, TXT, etc) on a zone.

network/dns/zone/history/compare

Compare a history entry to the current state of a zone.

Returns a hashref of arrayrefs of records. Each record is complete with the addition of an extra key

action => [qw/change delete add/]

Indicating what action needs to be take to the current zone to reset it back to that point in time

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
zone_id
integer (RELATION_ID) ^[1-9]\d*\z
Example: zone_id=54321

A valid id number (a positive integer).

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

A valid id number (a positive integer).

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
{
  • "records": [
    ]
}

network/dns/zone/history/list

Retrieve a list of zone history records, for a given zone_id.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
object
zone_id
integer (RELATION_ID) ^[1-9]\d*\z
Example: zone_id=54321

A valid id number (a positive integer).

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

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

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.

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
}

Firewall

This section contains methods for manipulating the firewall of a storm server.

network/firewall/details

Get details about the current firewall settings for a particular server. If no firewall is applied, a type of 'none' is returned. Otherwise, you get the various firewall types: 'basic', 'advanced', or 'saved', along with relevant details that apply to that firewall type. The system the firewall is setup under is also returned.

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
{
  • "allow": [
    ],
  • "rules": [
    ],
  • "ruleset": "string",
  • "system": "liquidweb",
  • "type": "string"
}

network/firewall/getbasicoptions

Returns a list of options that the basic firewall accepts.

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
{
  • "options": [
    ]
}

network/firewall/rules

Returns the rules for the given server, regardless of type. The rules are returned under the rules field, which is an array reference.

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
{
  • "rules": [
    ],
  • "uniq_id": "string"
}

network/firewall/update

Updates the firewall setting for a given server. The argument should mirror the data structures returned by details, with the addition of the uniq_id field.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
type
string (FIREWALL_TYPE)

A valid firewall type (basic, saved, advanced, or none).

allow
Array of strings (FIREWALL_ALLOW_LIST)

An array of basic firewall options

ruleset
string (FIREWALL_RULESET) ^[^[:cntrl:]]*$

A firewall ruleset name

rules
Array of strings (FIREWALL_RULE_LIST)

An array of firewall rules.

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
{
  • "modified": "string"
}

Firewall/Ruleset

You can save your current firewall settings into a ruleset, which you can then apply to other servers, allowing you to give predefined roles to various servers.

This section of the API gives you access to saving and querying your
saved rulesets.

network/firewall/ruleset/create

Saves the ruleset that the given server is using under the given name. The server will be set to a firewall type of 'saved', with this ruleset as its ruleset.

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.

name
string (FIREWALL_RULESET) ^[^[:cntrl:]]*$

A firewall ruleset name

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,
  • "destination_ips": [
    ],
  • "rules": [
    ],
  • "ruleset": "string",
  • "uniq_id": "string"
}

network/firewall/ruleset/details

Returns the rules and valid destinations ips for the given ruleset.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
ruleset
string (FIREWALL_RULESET) ^[^[:cntrl:]]*$

A firewall ruleset name

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,
  • "destination_ips": [
    ],
  • "rules": [
    ],
  • "ruleset": "string",
  • "subaccnts": [
    ],
  • "system": "liquidweb",
  • "uniq_id": "string"
}

network/firewall/ruleset/list

Returns an array reference of rulesets that have been saved for use by this account.

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.

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

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
}

network/firewall/ruleset/update

Updates the saved ruleset with the given ruleset. Returns a list of affected servers.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
rules
Array of strings (FIREWALL_RULE_LIST)

An array of firewall rules.

ruleset
string (FIREWALL_RULESET) ^[^[:cntrl:]]*$

A firewall ruleset name

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
{
  • "updated": [
    ]
}

IP

This section provides methods for listing and manipulating the IPs assigned to a server.

network/ip/add

Add a number of IPs to an existing server. If the 'configure_ips' flag is passed in, the new IP address(es) will be configured within the servers operating system.

Each account has a per-server IP limit defined. By default, that limit is 8 IPv4 addresses and 1 IPv6 /64 per server. Any requests above that limit will fail. A customer can call in to have that limit adjusted if they have a valid use for them.

Bleed version supports Openstack servers of which are limited to a total of 5 IP addresses and can only add 1 IP address at a time. pool_ips, reboot, configure_ips, ip6_count, and pool6_ips args are not used. If passed in, they will be ignored.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
configure_ips
boolean (BOOLEAN)

A boolean value (0 or 1).

pool6_ips
Array of strings (CIDRV6)
uniq_id
string (SUBACCNT_UNIQ_ID) ^[A-HJ-NP-Z0-9]{6}\z

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

pool_ips
Array of strings <ipv4> (IPV4)
Example: pool_ips=172.0.0.1
ip_count
integer (NON_NEG_INT) ^\d+\z
Example: ip_count=12345

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

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

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

reboot
boolean (BOOLEAN)

A boolean value (0 or 1).

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

A non-negative integer value (i.e. 0 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
{
  • "adding": "string"
}

network/ip/details

Gets information about a particular IP.

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

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

ip
string (IP)

A valid IP address (v4 or v6)

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
{
  • "broadcast": "172.0.0.1",
  • "gateway": "string",
  • "id": 80,
  • "ip": "string",
  • "netmask": "string",
  • "network": "string"
}

network/ip/list

Gets a paginated list of all IP assignments for a particular server. More details about the returned data can be found under network/ip/details

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

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

expand_ips
boolean (BOOLEAN)

A boolean value (0 or 1).

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

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

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.

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
{
  • "item_count": 12345,
  • "item_total": 12345,
  • "items": [
    ],
  • "page_num": 80,
  • "page_size": 80,
  • "page_total": 80
}

network/ip/listaccntpublic

Gets a list of public network assignments for all provisioned subaccounts for a particular account, optionally for a specific zone only. With the include_pools flag, also includes IPs assigned to IP pools.

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.

include_pools
boolean (BOOLEAN)

A boolean value (0 or 1).

zone_id
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: zone_id=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).

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
}

network/ip/listpublic

Gets a paginated list of all public IPs for a particular server. More details about the returned data can be found under network/ip/details

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

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

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

expand_ips
boolean (BOOLEAN)

A boolean value (0 or 1).

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

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

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
{
  • "item_count": 12345,
  • "item_total": 12345,
  • "items": [
    ],
  • "page_num": 80,
  • "page_size": 80,
  • "page_total": 80
}

network/ip/remove

Remove a specific IP from a server. If the 'configure_ips' flag is passed in, the IP address will be de-configured within the servers operating system.

Note: At this time, it is impossible to remove the server's primary IP using the API

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.

reboot
boolean (BOOLEAN)

A boolean value (0 or 1).

ip
string (MULTI_TYPE)

One of [CIDRV6] or [IPV4].

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

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

configure_ips
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
{
  • "removing": "string"
}

network/ip/request

Request additional IPs for a server. Many server types (traditional dedicated for example) require manual intervention to add IPs. This method creates a ticket, requesting that the given number of IPs be added.

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.

usage_justification
string (TEXT_GENERAL)

A string permitting tabs, carriage returns and newlines

ip_count
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: ip_count=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.

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

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

LoadBalancer

Load Balancers will spread server load among a set of servers (aka nodes). This section of the API provides access for creating, adjusting, and removing load balancers from an account.

network/loadbalancer/addnode

Adds a single node to an existing loadbalancer.

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.

node
string <ipv4> (IPV4)
Example: node=172.0.0.1

An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

Content type
application/json
Example
{
  • "capabilities": { },
  • "cycle": "string",
  • "name": "string",
  • "nodes": [
    ],
  • "project_name": "string",
  • "region_id": 54321,
  • "services": [
    ],
  • "session_persistence": true,
  • "ssl_includes": true,
  • "ssl_termination": true,
  • "strategy": "string",
  • "uniq_id": "string",
  • "vip": "172.0.0.1"
}

network/loadbalancer/addservice

Adds a service to an existing loadbalancer.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
dest_port
integer (PORT_NUMBER) ^\d{1,5}\z
Example: dest_port=80

A valid network port number.

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

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

src_port
integer (PORT_NUMBER) ^\d{1,5}\z
Example: src_port=80

A valid network port number.

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
{
  • "capabilities": { },
  • "cycle": "string",
  • "name": "string",
  • "nodes": [
    ],
  • "project_name": "string",
  • "region_id": 54321,
  • "services": [
    ],
  • "session_persistence": true,
  • "ssl_includes": true,
  • "ssl_termination": true,
  • "strategy": "string",
  • "uniq_id": "string",
  • "vip": "172.0.0.1"
}

network/loadbalancer/available

Find out if a loadbalancer name is already in use on an account. Allows for preventing DuplicateRecord exceptions when creating new load balancers.

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

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

name
string (TEXT_GENERAL) <= 60 characters

A string permitting tabs, carriage returns and newlines

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,
  • "name": "string"
}

network/loadbalancer/create

Create a new loadbalancer. Valid loadbalance strategies can be found using the /Network/LoadBalancer/strategies method.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
session_persistence
boolean (BOOLEAN)

A boolean value (0 or 1).

services
Array of objects (LOADBALANCER_SERVICE)
ssl_termination
boolean (BOOLEAN)

A boolean value (0 or 1).

nodes
Array of strings <ipv4> (IPV4)
Example: nodes=172.0.0.1
ssl_includes
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.

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

A single word, consisting of only letters and digits.

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

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

ssl_key
string (PRIVATE_KEY)

A private key, including the BEGIN PRIVATE KEY and END PRIVATE KEY comments.

ssl_cert
string (SSL_CERT)

An ssl X509 public certificate, including the BEGIN CERTIFICATE and END CERTIFICATE comments.

name
string (TEXT_GENERAL) <= 60 characters

A string permitting tabs, carriage returns and newlines

ssl_int
string (SSL_CERT)

An ssl X509 public certificate, including the BEGIN CERTIFICATE and END CERTIFICATE comments.

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

Content type
application/json
Example
{
  • "capabilities": { },
  • "cycle": "string",
  • "name": "string",
  • "nodes": [
    ],
  • "project_name": "string",
  • "region_id": 54321,
  • "services": [
    ],
  • "session_persistence": true,
  • "ssl_includes": true,
  • "ssl_termination": true,
  • "strategy": "string",
  • "uniq_id": "string",
  • "vip": "172.0.0.1"
}

network/loadbalancer/delete

Delete a loadbalancer.

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
{
  • "deleted": "string"
}

network/loadbalancer/details

Get information about a specific loadbalancer.

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
{
  • "capabilities": { },
  • "cycle": "string",
  • "name": "string",
  • "nodes": [
    ],
  • "project_name": "string",
  • "region_id": 54321,
  • "services": [
    ],
  • "session_persistence": true,
  • "ssl_includes": true,
  • "ssl_termination": true,
  • "strategy": "string",
  • "uniq_id": "string",
  • "vip": "172.0.0.1"
}

network/loadbalancer/list

Gets a list of all loadbalancers on an account.

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

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

region
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: region=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
}

network/loadbalancer/possiblenodes

Gets a list of all possible Loadbalancer Nodes on an account, regardless of whether or not they are currently loadbalanced.

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

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

region
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: region=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
{
  • "items": [
    ]
}

network/loadbalancer/removenode

Removes a single node from an existing loadbalancer.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
node
string <ipv4> (IPV4)
Example: node=172.0.0.1

An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)

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
{
  • "capabilities": { },
  • "cycle": "string",
  • "name": "string",
  • "nodes": [
    ],
  • "project_name": "string",
  • "region_id": 54321,
  • "services": [
    ],
  • "session_persistence": true,
  • "ssl_includes": true,
  • "ssl_termination": true,
  • "strategy": "string",
  • "uniq_id": "string",
  • "vip": "172.0.0.1"
}

network/loadbalancer/removeservice

Removes a single service from an existing loadbalancer.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
src_port
integer (PORT_NUMBER) ^\d{1,5}\z
Example: src_port=80

A valid network port number.

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
{
  • "capabilities": { },
  • "cycle": "string",
  • "name": "string",
  • "nodes": [
    ],
  • "project_name": "string",
  • "region_id": 54321,
  • "services": [
    ],
  • "session_persistence": true,
  • "ssl_includes": true,
  • "ssl_termination": true,
  • "strategy": "string",
  • "uniq_id": "string",
  • "vip": "172.0.0.1"
}

network/loadbalancer/strategies

Get a list of available strategies, with extra descriptive information.

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
{
  • "strategies": [
    ]
}

network/loadbalancer/update

Update an existing loadbalancer. Valid loadbalance strategies can be found using the /Network/LoadBalancer/strategies method.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
ssl_int
string (SSL_CERT)

An ssl X509 public certificate, including the BEGIN CERTIFICATE and END CERTIFICATE comments.

name
string (TEXT_GENERAL) <= 60 characters

A string permitting tabs, carriage returns and newlines

ssl_key
string (PRIVATE_KEY)

A private key, including the BEGIN PRIVATE KEY and END PRIVATE KEY comments.

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

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

ssl_cert
string (SSL_CERT)

An ssl X509 public certificate, including the BEGIN CERTIFICATE and END CERTIFICATE comments.

ssl_includes
boolean (BOOLEAN)

A boolean value (0 or 1).

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

nodes
Array of strings <ipv4> (IPV4)
Example: nodes=172.0.0.1
ssl_termination
boolean (BOOLEAN)

A boolean value (0 or 1).

session_persistence
boolean (BOOLEAN)

A boolean value (0 or 1).

services
Array of objects (LOADBALANCER_SERVICE)
Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

Content type
application/json
Example
{
  • "capabilities": { },
  • "cycle": "string",
  • "name": "string",
  • "nodes": [
    ],
  • "project_name": "string",
  • "region_id": 54321,
  • "services": [
    ],
  • "session_persistence": true,
  • "ssl_includes": true,
  • "ssl_termination": true,
  • "strategy": "string",
  • "uniq_id": "string",
  • "vip": "172.0.0.1"
}

Pool

Through these api methods, you can manage network IP Pools.

network/pool/create

Create a new IP Pool

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

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

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

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

add_ips
Array of strings (MULTI_TYPE)
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,
  • "assignments": [
    ],
  • "id": 80,
  • "uniq_id": "string",
  • "zone_id": 80
}

network/pool/delete

Deletes the given pool, and all the assignments that are only in the pool.

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.

subaccnt
integer (RELATION_ID) ^[1-9]\d*\z
Example: subaccnt=54321

A valid id number (a positive integer).

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
{
  • "deleted": 80
}

network/pool/details

Returns the details of a given IP pool.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
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).

free_only
boolean (BOOLEAN)

A boolean value (0 or 1).

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

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

subaccnt
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: subaccnt=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,
  • "assignments": [
    ],
  • "id": 80,
  • "uniq_id": "string",
  • "zone_id": 80
}

network/pool/list

Gets a list of network assignments for a particular IP Pool.

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.

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_].

zone_id
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: zone_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
{
  • "item_count": 12345,
  • "item_total": 12345,
  • "items": [
    ],
  • "page_num": 80,
  • "page_size": 80,
  • "page_total": 80
}

network/pool/update

Update an existing IP Pool

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

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

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

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

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

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

add_ips
Array of strings (MULTI_TYPE)
uniq_id
string (SUBACCNT_UNIQ_ID) ^[A-HJ-NP-Z0-9]{6}\z

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

subaccnt
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: subaccnt=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,
  • "assignments": [
    ],
  • "id": 80,
  • "uniq_id": "string",
  • "zone_id": 80
}

Private

Private networking provides the option for several Storm servers to contact each other via a network interface that is a) not publicly routeable and b) not metered for bandwidth. Applications that communicate internally will frequently use this for both security and cost-savings.

This section of the API provides methods for attaching and detaching a
server to a private network, and for querying information about an
existing private network.

network/private/attach

Attach a given server to your private network.

Note: This will automatically create the private network, if it is not already created.

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
{
  • "attached": "string"
}

network/private/bulkattachdetach

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
detach
Array of strings (SUBACCNT_UNIQ_ID)
attach
Array of strings (SUBACCNT_UNIQ_ID)
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
{
  • "success": true
}

network/private/detach

Detaches a given server to your private network.

Note: if this is the last server on your private network, the private vlan will be destroyed, so you will not be guaranteed the same private vlan id, should you re-enable private networking later.

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
{
  • "detached": "string"
}

network/private/get

Gets all of the servers attached to your private network, which zones they are in, and what IPs they are assigned.

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

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

zone_id
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: zone_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
{
  • "zones": [
    ]
}

network/private/getip

Gets the current private IP for a particular server, if it has one.

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
{
  • "ip": "string",
  • "legacy": true,
  • "uniq_id": "string"
}

network/private/isattached

Determine whether a given server is currently attached to your private network.

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
{
  • "is_attached": true
}

SSHKey

When storm servers are created, we generate an SSH key that we can use to access their server. This section of the api allows access to that information.

network/sshkey/get

Gets an ssh key for accessing an server.

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
{
  • "sshkey": "string"
}

Util

api methods for network utility functions.

network/util/resolvedomaintoip

Resolves the domain to it's given IP.

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)

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

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

Notifications

Sometimes we want to notify the user about a particular incident, such as service monitoring alerts, load monitoring alerts, background process progress, etc. This section of the API gives access to those alerts.

notifications/all

Get a list of all notifications for an account or server. More information about the data structure can be found in the storm/alerts/details method.

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

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

system
string (LAXWORDS) ^[\w -]*\z

A string consisting of only letters, digits, hyphens, spaces, and underscores.

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

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

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

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

resolved
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
}

notifications/current

Get a list of unresolved notifications for an account or server. More information about the data structure can be found in the storm/alerts/details method.

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.

system
string (LAXWORDS) ^[\w -]*\z

A string consisting of only letters, digits, hyphens, spaces, and underscores.

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

A single word, consisting of only letters and digits.

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

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

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

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

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

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

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
}

notifications/details

Gets information about a specific notification, including a history of all the alerts related to that notification. You can limit the number of historical alerts by specifying a 'limit'.

Here's a rundown of what those fields mean:

accnt: your account number

category: the category of alert, if any.  Examples are (list likely to grow):

    Provisioning - an alert from our provisioning system, which handles long-
    running background processes like creating servers, rebooting, etc

    Monitoring:* - our service monitoring system creates alerts in various
    categories based on which server was having issues.  Monitoring: host
    indicates that the primary service on the server was having issues.
    Other examples are Monitoring: http, Monitoring: mysql, etc.

    Bandwidth Overage Warning - you have exceeded or are within a certain
    percentage of your bandwidth quota on a server

description: the original description of the alert

enddate: the date and time the alert was closed, if it is closed

id: the id for this alert

modifieddate: the date and time the alert was last updated

severity:  the class of alert

    Notification: this alert is just to let you know that something has
    happened or is happening.

    Warning: indicates that something may be wrong, but is not yet serious.

    Error: something is wrong, like a service is not responding at all.

    Critical: something is seriously wrong and requires user acknowledgement
    to be closed.  Failed background processes from the provisioning system
    are the primary example here.

system: the system reporting the alert

    Provisioning: alerts from our provisioning system, which handle
    long-running background tasks, like building servers, rebooting, etc

    Service Monitoring: alerts from our service monitoring system

    Storm: alerts related to Storm downtime or maintenance

    Billing: alerts from our billing system.  Things like bandwidth overage
    notifications.

system_indentifier: some of the systems maintain their own unique identifiers
for each ongoing alert.  This is that identifier, if it exists.

uniq_id: the unique server identifier, made of 6 letters and numbers

alerts: if an alert is repeated or has progress updates, each individual
alert is kept and returns as a list here.  Other methods like list and open
do not return this bit of information
Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
system_identifier
integer (NON_NEG_INT) ^\d+\z
Example: system_identifier=12345

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

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

system
string (LAXWORDS) ^[\w -]*\z

A string consisting of only letters, digits, hyphens, spaces, and underscores.

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

A non-negative integer value (i.e. 0 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
{
  • "alerts": [
    ],
  • "category": "string",
  • "description": "string",
  • "domain": "example.com",
  • "enddate": "string",
  • "id": 80,
  • "last_alert": "string",
  • "modifieddate": "string",
  • "resolved": true,
  • "severity": "string",
  • "startdate": "string",
  • "system": "string",
  • "system_identifier": 80,
  • "uniq_id": "string"
}

notifications/resolve

Resolve an existing open notification. It will be marked as 'resolved' and no longer be returned by the 'current' method.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
id
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: id=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.

system
string (LAXWORDS) ^[\w -]*\z

A string consisting of only letters, digits, hyphens, spaces, and underscores.

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

A non-negative integer value (i.e. 0 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
{
  • "category": "string",
  • "description": "string",
  • "domain": "example.com",
  • "enddate": "string",
  • "id": 80,
  • "last_alert": "string",
  • "modifieddate": "string",
  • "resolved": true,
  • "severity": "string",
  • "startdate": "string",
  • "system": "string",
  • "system_identifier": 80,
  • "uniq_id": "string"
}

OneTimeSecret

Description Methods for working with OneTimeSecrets

onetimesecret/create

Creates a one time secret

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

Desired duration of time before the secret expires (in seconds).

expiration
string (DATETIME)

A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.

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

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

secret
string (TEXT_GENERAL)

A string permitting tabs, carriage returns and newlines

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,
  • "expiration": "string",
  • "expired": true,
  • "id": 54321,
  • "label": 80
}

onetimesecret/list

Returns details for all active secrets for a given accnt

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
alsowith
Array of any
Items Value: "secretLogs"
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).

object
expired
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
}

onetimesecret/read

Returns the decoded secret, which results in the secret being removed from the DB

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
id
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: id=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.

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

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

Product

This section contains some basic methods for getting lists of products, and details, prices of products.

product/details

Returns information about a product's pricing and options.

The product code for a specific server or service on an account can be found with the Server/Details method, under the 'type' field, and a list of valid product codes can be obtained via the Product/List method.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
alias
string (PRODUCT_ALIAS) ^[-a-z0-9._/]{1,100}\z

A string containing only lowercase letters, numbers, periods, hyphens, underscores, and slashes up to 100 max.

include_pov_tags
boolean (BOOLEAN)

A boolean value (0 or 1).

available_only
boolean (BOOLEAN)

A boolean value (0 or 1).

code
string (PRODUCT_CODE) ^[A-Za-z0-9._]{3,}\z

A valid product code, at least 3 chars long, including at least one letter.

(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

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

Response samples

Content type
application/json
Example
{
  • "alias": "string",
  • "ancestorCode": "string",
  • "capabilities": { },
  • "categories": [
    ],
  • "code": "string",
  • "credit_eligible": true,
  • "cycle": "string",
  • "default_price": 0.99,
  • "description": "string",
  • "discountable": true,
  • "features": [
    ],
  • "option_value_features": { },
  • "options": [
    ],
  • "parent_product": { },
  • "pov_tags": [
    ],
  • "prices": { },
  • "purchaseQuantityLimit": 80,
  • "related_product": { },
  • "series": [
    ],
  • "sub_title": "string",
  • "subdomain": "string",
  • "tax_code": "string",
  • "title": "string"
}

product/flatdetails

Returns all the necessary product data in a flat structure. If called by a user associated to an account, 'extra_data' will be included to provide account specific data.

By default, data returned will be reduced, in that keys/value pairs of which the value is null or empty (e.g. {} or []), the key/value pair is deleted from the returned data.

Optional parameter 'price_time_unit_override' will re-calculate prices to the specified override price time unit unless the price time unit is 'nontemporal' or 'deferred' or 'one-time'.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
product_code
string (PRODUCT_CODE) ^[A-Za-z0-9._]{3,}\z

A valid product code, at least 3 chars long, including at least one letter.

reduce_data
boolean (BOOLEAN)
Default: 1

A boolean value (0 or 1).

price_time_unit_override
any
Enum: "hour" "month" "quarter" "semiannual" "year"
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,
  • "categories": [
    ],
  • "credit_eligible": true,
  • "description": "string",
  • "discountable": true,
  • "flat_options": [
    ],
  • "marketplace_active": true,
  • "marketplace_description": "string",
  • "marketplace_display_order": 12345,
  • "marketplace_public": true,
  • "parent_product_id": 80,
  • "prepay_settings": { },
  • "price_time_unit": "string",
  • "primary_category": "string",
  • "product_code": "string",
  • "product_id": 54321,
  • "public": true,
  • "region_id_prices": { },
  • "related_product_id": 80,
  • "series_description": "string",
  • "series_display_order": 80,
  • "series_entry_display_order": 80,
  • "sub_title": "string",
  • "tags": [
    ],
  • "title": "string"
}

product/list

Returns production information for all products, or products in a series or category depending on the arguments passed. Only returns products available to the account.

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

One of [ARRAY[WORD]] or [WORD].

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

One of [WORD] or [ARRAY[WORD]].

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

A single word, consisting of only letters and digits.

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

One of [ARRAY[WORD]] 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).

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

A single word, consisting of only letters and digits.

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

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

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

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

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
}

Project

This section of the API allows for working with projects and their related assets

project/add

Add to an existing project.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
cluster
boolean (BOOLEAN)

A boolean value (0 or 1).

project_name
string (LAXERWORDS) ^[ \w.,':&/-]*\z

A string consisting of only the following permissible characters: space, letters, digits, hyphen, comma, period, apostrophe, underscore, colon, ampersand, slash.

assets
Array of strings (SUBACCNT_UNIQ_ID)
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
{
  • "added": true
}

project/available

Check to see if a project name is available.

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

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

project_name
string (LAXERWORDS) ^[ \w.,':&/-]*\z

A string consisting of only the following permissible characters: space, letters, digits, hyphen, comma, period, apostrophe, underscore, colon, ampersand, slash.

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
}

project/availableassets

Returns a list of assets that could potentially be added to the given project, grouped by category

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
category
any
Enum: "servers" "domains" "services"
project_name
string (LAXERWORDS) ^[ \w.,':&/-]*\z

A string consisting of only the following permissible characters: space, letters, digits, hyphen, comma, period, apostrophe, underscore, colon, ampersand, slash.

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
{
  • "assets": [
    ]
}

project/categories

Lists project categories.

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
{
  • "categories": [
    ]
}

project/create

Create a new project.

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

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

assets
Array of strings (SUBACCNT_UNIQ_ID)
cluster
boolean (BOOLEAN)

A boolean value (0 or 1).

project_name
string (LAXERWORDS) ^[ \w.,':&/-]*\z

A string consisting of only the following permissible characters: space, letters, digits, hyphen, comma, period, apostrophe, underscore, colon, ampersand, slash.

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,
  • "id": 80,
  • "project_name": "string"
}

project/delete

Delete an existing project.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
project_name
string (LAXERWORDS) ^[ \w.,':&/-]*\z

A string consisting of only the following permissible characters: space, letters, digits, hyphen, comma, period, apostrophe, underscore, colon, ampersand, slash.

id
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: id=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.

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

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

project/details

Show the details of one specific project

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
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).

project_name
string (LAXERWORDS) ^[ \w.,':&/-]*\z

A string consisting of only the following permissible characters: space, letters, digits, hyphen, comma, period, apostrophe, underscore, colon, ampersand, slash.

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

Content type
application/json
Example
{
  • "domains": [
    ],
  • "project_id": 54321,
  • "project_name": "string",
  • "servers": [
    ],
  • "services": [
    ]
}

project/list

Returns a paginated list of projects and related assets

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
object
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).

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
}

project/remove

Remove an asset or assets from a project.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
assets
Array of strings (SUBACCNT_UNIQ_ID)
id
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: id=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.

project_name
string (LAXERWORDS) ^[ \w.,':&/-]*\z

A string consisting of only the following permissible characters: space, letters, digits, hyphen, comma, period, apostrophe, underscore, colon, ampersand, slash.

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

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

project/rename

Rename a given project

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
project_name
string (LAXERWORDS) ^[ \w.,':&/-]*\z

A string consisting of only the following permissible characters: space, letters, digits, hyphen, comma, period, apostrophe, underscore, colon, ampersand, slash.

id
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: id=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.

new_project_name
string (LAXERWORDS) ^[ \w.,':&/-]*\z

A string consisting of only the following permissible characters: space, letters, digits, hyphen, comma, period, apostrophe, underscore, colon, ampersand, slash.

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,
  • "id": 80,
  • "project_name": "string"
}

Certificate

An SSL certificate allows for users to securely send information to a web service. In order for a certificate to be generally trusted, it needs to be signed by a trusted agent known as a certificate authority. The methods discussed in this document facilitate the process of ordering and managing certificates. The following directions will describe the process of ordering a new certificate via this API.

The first optional step is to call extractCSRDetails. It accepts a
single argument of a CSR. This method will determine if the CSR is for
a wildcard certificate, contact information in the CSR as well as if
the 'auto' verification method is available for this certificate. Auto
verification streamlines the verification process. This verification
method is only available if the domain for which the CSR is made has
DNS delegation to our name servers and if that domain's DNS zone is
listed under your account.

Next, the order method should be called to start the order process. The
return structure will have the details needed to call the verify
method. For example, if you chose the metatag verification method, you
would see a return structure like the following where html_meta_tag is
the meta tag which must be inserted into the head of the root html
document at one of the domains listed in the URLs array, and the
uniq_id is the identifier for the CSR:

    {
    ...
            uniq_id           => ssl_uniq_id,
            verification_data => {
                    ...
                    MetaTag => html_meta_tag,
                    URLs    => [acceptable_domain, ...]
            },
    ...
    }

Once the order call returns, the verify method may be called for the
new SSL order. This call requires the uniq_id of the CSR to be given
(this would have been returned by the order method), and one of email,
name, or URL depending on the desired verification method.

An extra step for email verification is to call confirmVerified which
will refresh the cache on the SSL order details and return the new set
of details including the certificate if email verification succeeded.

ssl/certificate/cancelorder

cancelOrder is a method used in the case you decide to cancel your certificate order.

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

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

subaccnt
integer (RELATION_ID) ^[1-9]\d*\z
Example: subaccnt=54321

A valid id number (a positive integer).

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
{
  • "cancelled": "string"
}

ssl/certificate/changeautorenew

Enables or disables auto-renewal for the specified SSL certificate.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
auto_renew
any
Enum: "On" "Off"
subaccnt
integer (RELATION_ID) ^[1-9]\d*\z
Example: subaccnt=54321

A valid id number (a positive integer).

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
{
  • "accnt": 0,
  • "autorenew_value": "On",
  • "certificate": {
    },
  • "created": "string",
  • "csr": "string",
  • "domain": "example.com",
  • "duration": 12,
  • "expiration": "string",
  • "id": 80,
  • "notified": true,
  • "order_id": "string",
  • "renewable": true,
  • "uniq_id": "string",
  • "verification_data": {
    },
  • "verification_method": "email",
  • "verification_status": "Pending",
  • "verify_urls": [
    ],
  • "wildcard": true
}

ssl/certificate/changeverificationmethod

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.

subaccnt
integer (RELATION_ID) ^[1-9]\d*\z
Example: subaccnt=54321

A valid id number (a positive integer).

verification_method
any
Enum: "dns" "metatag"
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,
  • "autorenew_value": "On",
  • "certificate": {
    },
  • "created": "string",
  • "csr": "string",
  • "domain": "example.com",
  • "duration": 12,
  • "expiration": "string",
  • "id": 80,
  • "notified": true,
  • "order_id": "string",
  • "renewable": true,
  • "uniq_id": "string",
  • "verification_data": {
    },
  • "verification_method": "email",
  • "verification_status": "Pending",
  • "verify_urls": [
    ],
  • "wildcard": true
}

ssl/certificate/confirmverified

Refreshes the certificate data cache in the case of email authentication.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
subaccnt
integer (RELATION_ID) ^[1-9]\d*\z
Example: subaccnt=54321

A valid id number (a positive integer).

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
{
  • "accnt": 0,
  • "autorenew_value": "On",
  • "certificate": {
    },
  • "created": "string",
  • "csr": "string",
  • "domain": "example.com",
  • "duration": 12,
  • "expiration": "string",
  • "id": 80,
  • "notified": true,
  • "order_id": "string",
  • "renewable": true,
  • "uniq_id": "string",
  • "verification_data": {
    },
  • "verification_method": "email",
  • "verification_status": "Pending",
  • "verify_urls": [
    ],
  • "wildcard": true
}

ssl/certificate/details

Retrieves the details of a particular SSL associated with the account.

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

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

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

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

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

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

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

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

subaccnt
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: subaccnt=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,
  • "autorenew_value": "On",
  • "certificate": {
    },
  • "created": "string",
  • "csr": "string",
  • "domain": "example.com",
  • "duration": 12,
  • "expiration": "string",
  • "id": 80,
  • "notified": true,
  • "order_id": "string",
  • "renewable": true,
  • "uniq_id": "string",
  • "verification_data": {
    },
  • "verification_method": "email",
  • "verification_status": "Pending",
  • "verify_urls": [
    ],
  • "wildcard": true
}

ssl/certificate/extractcsrdetails

This method examines a given CSR and checks to see if it is for a wildcard domain and if auto verification is a viable option.

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

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

csr
string (SSL_CSR)

An ssl certificate signing request, including the BEGIN CERTIFICATE REQUEST and END CERTIFICATE REQUEST comments.

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

Content type
application/json
Example
{
  • "autoVerifyCapable": true,
  • "city": "string",
  • "commonName": "string",
  • "country": "string",
  • "emailAddress": "string",
  • "invalidFields": [
    ],
  • "organization": "string",
  • "organizationalUnit": "string",
  • "san": [
    ],
  • "state": "string",
  • "wildcard": true
}

ssl/certificate/generate

The generate method is used to trgger generation of a new ssl certificate. This process is only valid if the given server uniq_id is a whm enabled server.

This process will take the provided information, and generate an ssl certificate on your server using the information. If the auto verification option is available, it will then proceed to carry out the verification process for the certificate, and then install it on your server.

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.

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

A valid state or province.

keysize
any
Default: 4096
Enum: 512 1024 2048 4096
organization
string (ORGNAME) ^(?i)[\P{IsC}]{2,100}\z

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

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

A valid city name.

autorenew
boolean (BOOLEAN)

A boolean value (0 or 1).

subaccnt
integer (RELATION_ID) ^[1-9]\d*\z
Example: subaccnt=54321

A valid id number (a positive integer).

country
string (COUNTRY_CODE_SPECIFIC)

A valid ISO country code.

verification_method
any
Enum: "dns" "metatag" "auto"
wildcard
boolean (BOOLEAN)

A boolean value (0 or 1).

commonName
string <hostname> (DOMAIN_FULL)
Example: commonName=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.

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

A valid name, up to 100 characters in length.

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

A valid email address.

duration
any
Default: 1
Enum: 1 2 3
Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

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

ssl/certificate/hostservers

Returns a list of servers which are candidates for automatic SSL certificate generation and installation. Will return details on if the servers which are candidates support the needed functionality.

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
{
  • "DYNAMIC[HOSTNAME]": {
    }
}

ssl/certificate/limits

This method returns a count of how many certificates have been ordered in the billing cycle and how many are allowed to be ordered (there is a limit if they are a reseller).

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
{
  • "current": 80,
  • "limit": 80,
  • "limit_reached": true
}

ssl/certificate/list

Lists the SSL orders associated with the account.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
renewable
boolean (BOOLEAN)

A boolean value (0 or 1).

verification_status
any
Enum: "Pending" "Attempted" "Delayed" "Failed" "Verified"
wildcard
boolean (BOOLEAN)

A boolean value (0 or 1).

verification_method
any
Enum: "email" "dns" "metatag"
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.

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

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

object
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 <hostname> (DOMAIN_ANY)
Example: domain=example.com

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

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
}

ssl/certificate/order

Begins the order process.

Note: auto verification involves adding a TXT record to the DNS zone which has authority over the domain specified in the CSR. In order for this option to be available, the domain's delegation must specify our DNS servers as having authority over it and the DNS zone must exist in your account.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
csr
string (SSL_CSR)

An ssl certificate signing request, including the BEGIN CERTIFICATE REQUEST and END CERTIFICATE REQUEST comments.

verification_method
any
Enum: "auto" "dns" "metatag"
duration
any
Default: 1
Enum: 1 2 3
domain
string (MULTI_TYPE)

One of [DOMAIN_FULL] or [RR_WILDCARD].

autorenew
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,
  • "autorenew_value": "On",
  • "certificate": {
    },
  • "created": "string",
  • "csr": "string",
  • "domain": "example.com",
  • "duration": 12,
  • "expiration": "string",
  • "id": 80,
  • "notified": true,
  • "order_id": "string",
  • "renewable": true,
  • "uniq_id": "string",
  • "verification_data": {
    },
  • "verification_method": "email",
  • "verification_status": "Pending",
  • "verify_urls": [
    ],
  • "warning": "string",
  • "wildcard": true
}

ssl/certificate/renew

Renew allows for renewing a certificate for a certain period of time. Calling this method will require an iteration of the verification process again.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
subaccnt
integer (RELATION_ID) ^[1-9]\d*\z
Example: subaccnt=54321

A valid id number (a positive integer).

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.

duration
any
Default: 1
Enum: 1 2 3
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,
  • "autorenew_value": "On",
  • "certificate": {
    },
  • "created": "string",
  • "csr": "string",
  • "domain": "example.com",
  • "duration": 12,
  • "expiration": "string",
  • "id": 80,
  • "notified": true,
  • "order_id": "string",
  • "renewable": true,
  • "uniq_id": "string",
  • "verification_data": {
    },
  • "verification_method": "email",
  • "verification_status": "Pending",
  • "verify_urls": [
    ],
  • "wildcard": true
}

ssl/certificate/verification

Given a server that we will be generating a CSR on, and a domain that the certificate will be for, return the list of valid certificate verification methods.

This is accomplished primarily by identifying if the dns for the domain is hosted on LiquidWeb nameservers, or if the nameservers for the domain reside on the server we're generating the csr on to determine the validity of the automatic verification method.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
subaccnt
integer (RELATION_ID) ^[1-9]\d*\z
Example: subaccnt=54321

A valid id number (a positive integer).

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

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

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.

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

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

ssl/certificate/verify

Performs the verification check. Depending on the verification method specified in the order method, a particular argument will need to be given to the verify method.

Verification Method | argument | value
===============================================================================
dns                 | name     | One of the approved domains to check its DNS
                    |          | TXT record
--------------------+----------+-----------------------------------------------
metatag             | url      | URL to the root of one of the approved domains

Note: If the verification method was email, an additional call to confirmVerified is needed to refresh the data cache.

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

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

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

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

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

One of [ARRAY[URI_HTTP]] or [URI_HTTP].

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

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

subaccnt
integer (RELATION_ID) ^[1-9]\d*\z
Example: subaccnt=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
{
  • "accnt": 0,
  • "autorenew_value": "On",
  • "certificate": {
    },
  • "created": "string",
  • "csr": "string",
  • "domain": "example.com",
  • "duration": 12,
  • "expiration": "string",
  • "id": 80,
  • "notified": true,
  • "order_id": "string",
  • "renewable": true,
  • "uniq_id": "string",
  • "verification_data": {
    },
  • "verification_method": "email",
  • "verification_status": "Pending",
  • "verify_urls": [
    ],
  • "wildcard": true
}

Server

This section of the API handles provisioning, destroying, resizing, cloning, etc. Basically anything to do with managing a server is here.

Many of the methods here will fire off long-running processes that run
in the background and can be polled for status information.

server/available

Checks if a given domain is free. Will return an adjusted domain name

If given an account and there was a conflict with another domain on your account. For example, if you have a server called 'host.domain.com', and ask if 'host.domain.com' is available, 'host2.domain.com' will be returned as the available domain.

If the domain is entirely unavailable, an exception of type 'LW::Exception::Resource::Unavailable' will be returned.

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

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

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

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

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

Content type
application/json
Example
{
  • "domain": "example.com"
}

server/clone

Clone a server. Returns the information about the newly created clone.

All of the optional fields are defaulted to the values on the original server if they aren't received. For cloning to a private parent, include the uniq_id of the parent server to be cloned to, along with the memory/diskspace/vcpu amounts (if different from the original).

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.

pool_ips
Array of strings <ipv4> (IPV4)
Example: pool_ips=172.0.0.1
config_id
integer (NON_NEG_INT) ^\d+\z
Example: config_id=12345

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

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

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

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

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

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

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

pool6_ips
Array of strings (CIDRV6)
domain
string <hostname> (DOMAIN_FULL)
Example: domain=example.com

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

password
string (STORM_INSTANCE_PASSWORD) ^[a-zA-Z0-9~!\@#\$%^&*_+=`|\\(){}\[\]:;<>,.?/...

A password of at least 7 characters and up to 30 characters in length, containing no spaces. Must contain 3 of the 4 following classes: lowercase, uppercase, numbers and punctuation.

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

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

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

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

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

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

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

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

vcpu
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: vcpu=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,
  • "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": { }
}

server/consoleaddress

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
{
  • "hostname": "example.com",
  • "ip": "172.0.0.1",
  • "port": 80
}

server/create

Provision a new server. This fires off the build process, which does the actual provisioning of a new server on its parent. Each server consists of several distinct options:

type: the product code for the provisioned server to create.

features: an associative array of product features, specifying extra
configuration options for the server.  The keys and values for this allow
specifying features such as MsSQL and AntiVirus service on Windows systems,
and can be determined by calling the product/details method for the product
code of the server, and examining the 'options' array.  In general, these
settings are not necessary on Linux systems, and are only necessary on
servers with a Windows operating system.

image_id: rather than provisioning a LiquidWeb template, you can specify
the id of a user-created image on your account.  Use the API method
storm/image/list to find any existing images you have or storm/image/create
to create a new image from an existing server

new_ips: the number of IPs you wish the server to have.  This defaults to
1 IP, which is included in the base price.  Pricing for additional IPs can
be found using the product/details API method for the product type in
question, under 'options', specified as 'ExtraIp'

new_ip6s: the number of IPv6 /64s you wish the server to have. By default,
you are limited to a maximum of 1.

pool_ips: an optional array of IPv4 ips to be assigned to the server from
the ip pool.

pool6_ips: an optional array of IPv6 /64s to be assigned to the server from
the ip pool.

bandwidth_quota: the bandwidth plan you wish to use.  A quota of 0 indicates
that you want as-you-go, usage-based bandwidth charges.  The remaining
available quota options can be found with the product/details API method.

backup_enabled: whether or not backups should be enabled.  Defaults to no.
If this is not set to 1, neither of the following two options will be used.

backup_plan: either 'quota' or 'daily', depending on whether you are
choosing a quota-based backup plan or just a specific number of days to be
backed up.

backup_quota: for a 'daily' plan, this indicates the number of days to back
up.  For a quota plan, this is the total number of GB to keep.  Available
options are found with the product/details API method.

public_ssh_key: optional public ssh key you want added to authorized_keys
on your new server.  This should be a valid public ssh key, e.g. the contents
of your id_rsa.pub file.

zone: the numerical id for the zone you wish to deploy the server in.
See network/zone/list for available zones.

Beyond those options, we need the hostname of the server ('domain') and the root password you would like set on the server originally ('password').

More information about the returned data structure are found in the documenation for the server/details method.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
pool_ips
Array of strings <ipv4> (IPV4)
Example: pool_ips=172.0.0.1
zone
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: zone=80

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

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

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

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

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

pool6_ips
Array of strings (CIDRV6)
public_ssh_key
string (MULTI_TYPE)

One of [SSH_KEY_PUBLIC] or [WORD_].

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

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

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

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

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

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

type
string (ACCOUNT_TYPE) ^[A-Za-z0-9.]{3,}\z

A valid subaccnt type descriptor (i.e. DS.W1, GUARD, etc), at least 3 chars long.

features
object (HASH)
Example:

An associative array of arbitrary keys and values.

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

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

password
string (STORM_INSTANCE_PASSWORD) ^[a-zA-Z0-9~!\@#\$%^&*_+=`|\\(){}\[\]:;<>,.?/...

A password of at least 7 characters and up to 30 characters in length, containing no spaces. Must contain 3 of the 4 following classes: lowercase, uppercase, numbers and punctuation.

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

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

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

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

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

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

vcpu
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: vcpu=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,
  • "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": { }
}

server/destroy

Kills a server. It will refund for any remaining time that has been prepaid, charge any outstanding bandwidth charges, and then start the workflow to tear down the server.

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.

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

cancellation_reason
string (TEXT_GENERAL)

A string permitting tabs, carriage returns and newlines

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

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

server/details

Gets data relevant to a provisioned server.

Here's a rundown of what the returned fields mean:

active: a flag indicating whether or not the server has finished building

backup_enabled: whether or not backups are enabled

backup_plan: either 'quota' or 'daily', depending on which backup plan you
have enabled.  If backups are not enabled, this field is empty.

backup_quota: for a 'daily' plan, this indicates the number of days backed
up. For a quota plan, this is the total number of GB of backups kept for
this server. If backups are not enabled, this field is empty.

backup_size: the number of GB your current backups are using

bandwidth_quota: the number of GB of bandwidth included in your bill.
O indicates as-you-go usage-based bandwidth.

capabilities: a list of capabilities the server has

config_id: the id of the server configuration this server is using

config_description: a more descriptive name for the server configuration
assigned to this server. 'Storm 2GB', for example.

create_date: the date and time when the server was created

features: a list of features the server is configured with

ip: the primary IP of the server

ip_count: the number of IPs the server has assigned to it

manage_level: 'self', 'core', or 'full', determined by which template you
chose when creating the server

    self: Includes support for hardware, network and virtualization layers.

    core: Includes complete support of the base operating system as well as
    Apache, Mysql and PHP. Proactive service restoration is provided.

    full: Includes cPanel + Fantastico as well complete support of base
    operating system and all cPanel services. Proactive service restoration
    is provided.

template: which OS image you have installed.  Even when you create a server
from an image, the original OS image is returned here.

template_description: a more informative description of the OS you are using
on this server.  'CentOS 5.5 64bit Core-Managed', for example.

uniq_id: the unique server identifier, made of 6 letters and numbers

zone: the zone in which your server resides.  This is not yet useful, but is
still provided as reference.  The zone identifiers may change.
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
{
  • "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": { }
}

server/history

Get a list of notifications for a specific server. Information about the data returned can here be found in storm/alerts/details

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

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

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
{
  • "item_count": 12345,
  • "item_total": 12345,
  • "items": [
    ],
  • "page_num": 80,
  • "page_size": 80,
  • "page_total": 80
}

server/list

Get a list of servers, services, and devices on your account. A more detailed description of what is returned can be found in the documentation for the server/details method.

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
domain
string (LINE) ^[^[:cntrl:]]*\z

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

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

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

exclude_default_alsowiths
boolean (BOOLEAN)

A boolean value (0 or 1).

type
string (ACCOUNT_TYPE) ^[A-Za-z0-9.]{3,}\z

A valid subaccnt type descriptor (i.e. DS.W1, GUARD, etc), at least 3 chars long.

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

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

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

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

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 (strings) or WORD (string) (MULTI_TYPE)

One of [ARRAY[WORD]] or [WORD].

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
}

server/reboot

Reboot a server. The 'force' flag will do a hard shutdown/boot of the server from the parent server.

If the server in question does not support automatic rebooting, a reboot request will be created as a support ticket.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
force
boolean (BOOLEAN)

A boolean value (0 or 1).

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
{
  • "rebooted": "string",
  • "requested": "string"
}

server/resize

Resize a server to a new configuration. Available config_ids can be found in storm/config/list

You will be billed for the prorated difference of the price of the new configuration compared to the price of your old configuration. The difference will be refunded or charged at your next billing date.

When resizing to a larger configuration, the filesystem resize operation can be skipped by passing the 'skip_fs_resize' option. In this case, the storage associated with the new configuration is allocated, but not available immediately. The filesystem resize should be scheduled with the support team.

Skipping the filesystem resize is only possible when moving to a larger configuration. This option has no effect if moving to the same or smaller configuration.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
skip_fs_resize
boolean (BOOLEAN)

A boolean value (0 or 1).

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

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

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

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

PRODUCT_CODE (string) or KEYWORD (string) or NON_NEG_INT (integer) (MULTI_TYPE)

One of [PRODUCT_CODE] or [KEYWORD] or [NON_NEG_INT].

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

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

vcpu
integer (POSITIVE_INT) ^[1-9]\d*\z
Example: vcpu=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.

parent
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": { }
}

server/resizevolume

Resizes the volume of a server. Only used for specific types of products where the drive size is fully separated from cpu/ram. For example, products that operate on OpenStack would use this method to resize volumes.

Volumes can only be increased in size and CANNOT be made smaller.

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.

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

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

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,
  • "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": { }
}

server/shutdown

Stop a server. The 'force' flag will do a hard stop of the server from the parent server. Otherwise, it will issue a halt command to the server and shutdown normally.

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

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

force
boolean (BOOLEAN)

A boolean value (0 or 1).

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
{
  • "shutdown": "string"
}

server/start

Boot a server. If the server is already running, this will do nothing.

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
{
  • "started": "string"
}

server/update

Update details about your server, including the backup and bandwidth plans, any advanced authentication options, and the hostname ('domain') we have on file.

Updating the 'domain' field will not change the actual hostname on the server. It merely updates what our records show.

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": { }
}

Auth

This sections provide methods for liquidweb's stored auth. On managed servers, we may need to log into the machine from time to time. We use the authentication information stored with these methods to do so.

server/auth/details

Returns the stored auth information for a server. This method does not return either the main or alternate password.

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
{
  • "alternate_ssh_ip": "172.0.0.1",
  • "alternate_ssh_port": 80,
  • "login_username": "string",
  • "special_instructions": "string",
  • "uniq_id": "string",
  • "whm_access_key_valid": true
}

server/auth/update

Updates the stored authentication information for a server. Any of these fields can be blanked by setting the field to an empty string ('').

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
control_panel_password
string (GENERIC_PASSWORD) ^[^[:cntrl:]]{1,63}\z

A password, up to 63 characters in length

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

special_instructions
string (TEXT_GENERAL)

A string permitting tabs, carriage returns and newlines

alternate_ssh_ip
string <ipv4> (IPV4)
Example: alternate_ssh_ip=172.0.0.1

An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)

password
string (GENERIC_PASSWORD) ^[^[:cntrl:]]{1,63}\z

A password, up to 63 characters in length

login_password
string (GENERIC_PASSWORD) ^[^[:cntrl:]]{1,63}\z

A password, up to 63 characters in length

alternate_ssh_port
integer (PORT_NUMBER) ^\d{1,5}\z
Example: alternate_ssh_port=80

A valid network port number.

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

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

whm_access_key
string (TEXT_GENERAL)

A string permitting tabs, carriage returns and newlines

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

Content type
application/json
Example
{
  • "alternate_ssh_ip": "172.0.0.1",
  • "alternate_ssh_port": 80,
  • "login_username": "string",
  • "special_instructions": "string",
  • "uniq_id": "string"
}

WHM/DNS

API methods for working with DNS via the WHM API

server/whm/dns/listzones

This method lists all the dns zones on a given WHM server.

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
{
  • "zones": [
    ]
}

Block/Cluster

Block storage clusters are available in specific zones, and this method offers information on the availability for a cluster. Block storage volumes must be created in the same zone as the instance it will be attached to.

storage/block/cluster/list

Get a paginated list of block storage clusters, including the zone that the cluster is in.

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

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
}

Block/Volume

Block storage offers a method to attach additional storage to server instances. Once attached, volumes appear as normal block devices, and can be used as such.

storage/block/volume/attach

Attach a volume to a particular instance.

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

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

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
{
  • "attached": "string",
  • "to": "string"
}

storage/block/volume/create

Create a new volume.

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

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

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

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

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

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

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

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

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

attach
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
{
  • "attachedTo": [
    ],
  • "cross_attach": true,
  • "domain": "string",
  • "label": "string",
  • "size": 80,
  • "status": "string",
  • "uniq_id": "string",
  • "zoneAvailability": [
    ]
}

storage/block/volume/delete

Delete a volume, including any and all data stored on it. The volume must not be attached to any instances to call this method.

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
{
  • "deleted": "string"
}

storage/block/volume/detach

Detach a volume from an instance. This method is roughly equivalent to unplugging an external drive, and it is important to ensure the volume is unmounted before using this method.

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

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

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

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

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
{
  • "detached": "string",
  • "detached_from": "string"
}

storage/block/volume/details

Retrieve information about a specific volume.

Here's a rundown of what the returned fields mean:

accnt: your account number

id: the id of the volume

domain: the name you gave the volume on creation

size: the size of the volume, in GB

status: status of the volume (unprovisioned, active, or attached)

uniq_id: the unique identifier, made of 6 letters and numbers, of the volume.

attached_to: the unique identifier of the server this volume
         is attached to (or 'null').

device: if the volume is attached to a server,
    this is the device that it is attached as.
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
{
  • "attachedTo": [
    ],
  • "cross_attach": true,
  • "domain": "string",
  • "label": "string",
  • "size": 80,
  • "status": "string",
  • "uniq_id": "string",
  • "zoneAvailability": [
    ]
}

storage/block/volume/list

Get a paginated list of block storage volumes for your account. More information about the returned data structure can be found in the documentation for storage/block/volume/details

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
attached_to
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.

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

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
}

storage/block/volume/resize

Resize a volume. Volumes can currently only be resized larger.

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

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

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

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

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
{
  • "new_size": 80,
  • "old_size": 80,
  • "uniq_id": "string"
}

storage/block/volume/update

Update an existing volume. Currently, only renaming the volume is supported. More information about the returned data structure can be found in the documentation for storage/block/volume/details/

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
domain
string (LINE) ^[^[:cntrl:]]*\z

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

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

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

cross_attach
boolean (BOOLEAN)

A boolean value (0 or 1).

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
{
  • "attachedTo": [
    ],
  • "cross_attach": true,
  • "domain": "string",
  • "label": "string",
  • "size": 80,
  • "status": "string",
  • "uniq_id": "string",
  • "zoneAvailability": [
    ]
}

ObjectStore

This section contains methods to manage the object store.

storage/objectstore/create

create a new object store.

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,
  • "caps": [
    ],
  • "display_name": "string",
  • "host": "example.com",
  • "keys": [
    ],
  • "max_buckets": 80,
  • "suspended": true,
  • "uniq_id": "string",
  • "user_id": "string"
}

storage/objectstore/createkey

Create a new key for a specific Rados Gateway user

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
{
  • "access_key": "string",
  • "secret_key": "string",
  • "user": "string"
}

storage/objectstore/delete

Delete an object store.

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
{
  • "deleted": "string"
}

storage/objectstore/deletekey

Delete an existing key for a specific Rados Gateway user

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
access_key
string (STRING) ^.+\z

A string.

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
{
  • "deleted": "string"
}

storage/objectstore/details

Get information about an object store.

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
{
  • "caps": [
    ],
  • "display_name": "string",
  • "host": "example.com",
  • "keys": [
    ],
  • "max_buckets": 80,
  • "suspended": true,
  • "user_id": "string"
}

storage/objectstore/diskspace

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
{
  • "buckets": { },
  • "total": 12345
}

SystemStatus

This section of the API handles basic operations on our system statuses. Currently, you can receive information on unresolved and upcoming incidents.

support/systemstatus/incidentsummary

Returns information on all unresolved and upcoming incidents. The base class caches this information for 60 seconds for speed as well as API limits

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
{
  • "cloudsites": {
    },
  • "liquidweb": {
    }
}

Info

This section contains some basic methods for getting the version and state of the api.

utilities/info/ping

This method can be used as a basic check to see if communication with the api is possible.

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
{
  • "ping": "string"
}

utilities/info/version

Returns the version of the of the api your are using.

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
{
  • "version": "string"
}

utilities/info/whatismyip

Returns the IP address of the api client, as seen by the api.

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
{
  • "ip": "string"
}

VIP

This section contains methods to manage the Virtual IP services of a particular account.

vip/create

create a new Virtual IP service.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
zone
integer (INTEGER) ^-?\d+\z
Example: zone=12345

An integer value.

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

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

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

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

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,
  • "activeStatus": "string",
  • "domain": "string",
  • "uniq_id": "string",
  • "zone": 80
}

vip/destroy

remove a Virtual IP 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.

subaccnt
integer (RELATION_ID) ^[1-9]\d*\z
Example: subaccnt=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
{
  • "destroyed": "string"
}

vip/details

Get information about the VIP subaccnt.

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
{
  • "active": true,
  • "activeStatus": "string",
  • "domain": "string",
  • "uniq_id": "string",
  • "zone": 80
}

VPN

This section contains methods to manage the VPN service of a particular account.

vpn/adduser

Create a new VPN user

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
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

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.

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

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

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

One of [SUBACCNT_UNIQ_ID] or [ARRAY[SUBACCNT_UNIQ_ID]].

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

The first, middle, or last name of an individual, up to 50 characters 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
{
  • "user_details": { }
}

vpn/authorized

Determine if a particular user is allowed to use the VPN. Returns the details of a single VPN user.

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

region_id
integer (RELATION_ID) ^[1-9]\d*\z
Example: region_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
{
  • "ip": "172.0.0.1",
  • "netmask": "172.0.0.1"
}

vpn/create

create a new VPN service.

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

An associative array of arbitrary keys and values.

region_id
integer (INTEGER) ^-?\d+\z
Example: region_id=12345

An integer value.

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.

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,
  • "activeStatus": "string",
  • "current_users": 12345,
  • "domain": "example.com",
  • "max_users": 80,
  • "network_range": [
    ],
  • "region_id": 80,
  • "uniq_id": "string"
}

vpn/details

Get information about VPN access for this account.

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
{
  • "active": true,
  • "activeStatus": "string",
  • "current_users": 12345,
  • "domain": "example.com",
  • "max_users": 80,
  • "network_range": [
    ],
  • "region_id": 80,
  • "uniq_id": "string",
  • "vpn": {
    }
}

vpn/list

Lists the authorized VPN users for a given accnt.

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

One of [SUBACCNT_UNIQ_ID] or [ARRAY[SUBACCNT_UNIQ_ID]].

region_id
integer (RELATION_ID) ^[1-9]\d*\z
Example: region_id=54321

A valid id number (a positive integer).

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

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
}

vpn/removeuser

Remove a VPN user

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

One of [SUBACCNT_UNIQ_ID] or [ARRAY[SUBACCNT_UNIQ_ID]].

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
{
  • "removed": "string"
}

vpn/update

Update the features of a VPN service.

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

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

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

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

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

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

features
object (HASH)
Example:

An associative array of arbitrary keys and values.

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,
  • "activeStatus": "string",
  • "current_users": 12345,
  • "domain": "example.com",
  • "max_users": 80,
  • "network_range": [
    ],
  • "region_id": 80,
  • "uniq_id": "string"
}

User

This section contains methods to manage VPN users on particular accounts.

vpn/user/create

Create a new VPN user for a particular account.

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

One of [ARRAY[SUBACCNT_UNIQ_ID]] or [SUBACCNT_UNIQ_ID].

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
{
  • "user_details": { }
}

vpn/user/delete

Remove a VPN user from this account. The user will still exist in the permissions system, but not have VPN access.

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.

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

One of [SUBACCNT_UNIQ_ID] or [ARRAY[SUBACCNT_UNIQ_ID]].

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

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

vpn/user/details

Get information about a specific VPN user on this account.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
region_id
integer (RELATION_ID) ^[1-9]\d*\z
Example: region_id=54321

A valid id number (a positive integer).

derive_region_from_calling_ip
boolean (BOOLEAN)

A boolean value (0 or 1).

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

One of [ARRAY[SUBACCNT_UNIQ_ID]] or [SUBACCNT_UNIQ_ID].

calling_ip
string <ipv4> (IPV4)
Example: calling_ip=172.0.0.1

An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)

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
{
  • "accnt": 0,
  • "ip": "172.0.0.1",
  • "netmask": "172.0.0.1",
  • "region_id": 54321,
  • "subaccnt": "string",
  • "user_id": 12345,
  • "username": "string"
}

vpn/user/list

Get a list of the current users for this account.

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
region_id
integer (RELATION_ID) ^[1-9]\d*\z
Example: region_id=54321

A valid id number (a positive integer).

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

One of [SUBACCNT_UNIQ_ID] or [ARRAY[SUBACCNT_UNIQ_ID]].

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

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

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.

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
}