LiquidWeb.com
API docs by Redocly

LiquidWeb API (v3)

LiquidWeb 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:

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/details

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

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
alsowith
Array of any
Items Enum: "acronisBackingUp" "ancestorServer" "backupsAndStorage" "businessEmailPricing" "capabilities" "categories" "children" "creation_date" "description" "diskDetails" "distro" "emailFriendlyName" "featureDetails" "finalizeDetails" "generatedDomainDetails" "hostedEmailPricing" "hostedEmailUsage" "hostingDetails" "instance" "loadbalancer" "machine" "managedType" "mesDetails" "monitorableServices" "mrc" "networkSummary" "nocworxRemoteDetails" "nocworxServiceDetails" "objectStore" "osFamily" "parentDetails" "powerStatus" "price" "primaryProductCategory" "privateParent" "product" "productDisplayGroup" "project" "prometheusDetails" "publicProductCategory" "region" "resourceState" "servers" "shortDescription" "usageDetails" "zone"
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
{
  • "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
alsowith
Array of any
Items Enum: "acronisBackingUp" "ancestorServer" "backupsAndStorage" "businessEmailPricing" "capabilities" "categories" "children" "creation_date" "description" "diskDetails" "distro" "emailFriendlyName" "featureDetails" "finalizeDetails" "generatedDomainDetails" "hostedEmailPricing" "hostedEmailUsage" "hostingDetails" "instance" "loadbalancer" "machine" "managedType" "mesDetails" "monitorableServices" "mrc" "networkSummary" "nocworxRemoteDetails" "nocworxServiceDetails" "objectStore" "osFamily" "parentDetails" "powerStatus" "price" "primaryProductCategory" "privateParent" "product" "productDisplayGroup" "project" "prometheusDetails" "publicProductCategory" "region" "resourceState" "servers" "shortDescription" "usageDetails" "zone"
public_category
string (WORD) ^(?i)[a-z0-9]*\z

A single word, consisting of only letters and digits.

domain_match
boolean (BOOLEAN)

Find all assets via partial domain match rather than exact match

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

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

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

A single word, consisting of only letters and digits.

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

object
exclude_category
Array of strings (WORD)
page_num
integer (POSITIVE_INT) ^[1-9]\d*\z
Default: 1
Example: page_num=80

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

domain
string (MULTI_TYPE)

One of [DOMAIN_FRAGMENT] or [DOMAIN_FULL].

status
string (SUBACCNT_STATUS)

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

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
Array of strings (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
}

asset/password

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
{
  • "password": "string",
  • "username": "string"
}

asset/remove

Request removal of this asset.

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

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.

rating
any
Enum: 0 5 10

Rating of customer's experience with Liquid Web.

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

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

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

asset/update

Change the details of a subaccnt.

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.

features
object (HASH)
Example:

An associative array of arbitrary keys and values.

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,
  • "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

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/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,
  • "token": "string",
  • "type": "string"
}

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

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

type
any
Enum: "Cloud.VPS" "Cloud.VPS.WIN" "Cloud.Metal" "Cloud.Metal.WIN" "Bare.Metal" "Bare.Metal.GPU"
plan_id
integer (RELATION_ID) ^[1-9]\d*\z
Example: plan_id=54321

A valid id number (a positive integer).

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

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

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

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
{
  • "accnt": 0,
  • "ip": "172.0.0.1",
  • "plan_id": "string",
  • "region_id": 54321,
  • "status": "string",
  • "template_name": "string",
  • "type": "Cloud.VPS",
  • "uniq_id": "string",
  • "username": "string",
  • "zone_id": 54321
}

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
uniq_id
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
{
  • "accnt": 0,
  • "ip": "172.0.0.1",
  • "plan_id": "string",
  • "region_id": 54321,
  • "status": "string",
  • "template_name": "string",
  • "type": "Cloud.VPS",
  • "uniq_id": "string",
  • "username": "string",
  • "zone_id": 54321
}

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

Note that this method has been deprecated. Use of asset/list is now preferred.

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

A valid IPV4 address, not in one of the reserved private ranges, and not localhost

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

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

type
any
Enum: "Cloud.VPS" "Cloud.VPS.WIN" "Cloud.Metal" "Cloud.Metal.WIN" "Bare.Metal" "Bare.Metal.GPU"
object
region_id
integer (RELATION_ID) ^[1-9]\d*\z
Example: region_id=54321

A valid id number (a positive integer).

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

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

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

status
string (LAXWORD) ^[\w-]*\z

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
}

server/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 (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
{
  • "password": "string"
}

server/terminate

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 (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,
  • "ip": "172.0.0.1",
  • "plan_id": "string",
  • "region_id": 54321,
  • "status": "string",
  • "template_name": "string",
  • "type": "Cloud.VPS",
  • "uniq_id": "string",
  • "username": "string",
  • "zone_id": 54321
}

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
password
string (LINE) ^[^[:cntrl:]]*\z

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

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

username
string (LAXWORD) ^[\w-]*\z

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
{
  • "accnt": 0,
  • "ip": "172.0.0.1",
  • "plan_id": "string",
  • "region_id": 54321,
  • "status": "string",
  • "template_name": "string",
  • "type": "Cloud.VPS",
  • "uniq_id": "string",
  • "username": "string",
  • "zone_id": 54321
}

Plan

This section of the API provides server plan information. A plan represents hardware specifications of a Cloud server or Bare Metal server. Note, that a plan is represented under a different term depending on the platform of the server you are deploying resides in. In the Cloud platform, a plan is called a config. In the Bare Metal platfrom, a plan is called a model.

server/plan/details

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
server_type
any
Enum: "Cloud.VPS" "Cloud.VPS.WIN" "Cloud.Metal" "Cloud.Metal.WIN" "Bare.Metal" "Bare.Metal.GPU"
id
integer (RELATION_ID) ^[1-9]\d*\z
Example: id=54321

A valid id number (a positive integer).

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

A valid id number (a positive integer).

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
{
  • "available": true,
  • "cores": 12345,
  • "cpu_cores": 12345,
  • "cpu_count": 12345,
  • "cpu_hyperthreading": true,
  • "cpu_model": "string",
  • "cpu_speed": 12345,
  • "description": "string",
  • "disk": 12345,
  • "disk_type": "string",
  • "gpu_count": 12345,
  • "gpu_name": "string",
  • "id": 54321,
  • "link_speed": 12345,
  • "memory": 12345,
  • "raid_level": 12345,
  • "region_id": 54321,
  • "server_type": "Cloud.VPS",
  • "type": "MachineModel",
  • "vcpu": 12345,
  • "zone_id": 54321
}

server/plan/list

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

server_type
any
Enum: "Cloud.VPS" "Cloud.VPS.WIN" "Cloud.Metal" "Cloud.Metal.WIN" "Bare.Metal" "Bare.Metal.GPU"
region_id
integer (RELATION_ID) ^[1-9]\d*\z
Example: region_id=54321

A valid id number (a positive integer).

object
available
boolean (BOOLEAN)
Default: 1

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
}

Power

This section of the API handles server power related functions.

server/power/check

Return the current power status of the requested 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
{
  • "error": "string",
  • "powerStatus": "string",
  • "resource": "string",
  • "status": "string",
  • "task": 80
}

server/power/reboot

Reboot the requested 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
{
  • "error": "string",
  • "powerStatus": "string",
  • "resource": "string",
  • "status": "string",
  • "task": 80
}

server/power/reset

Reset the requested 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
{
  • "error": "string",
  • "powerStatus": "string",
  • "resource": "string",
  • "status": "string",
  • "task": 80
}

server/power/shutdown

Shutdown the requested 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
{
  • "error": "string",
  • "powerStatus": "string",
  • "resource": "string",
  • "status": "string",
  • "task": 80
}

server/power/start

Start the requested 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
{
  • "error": "string",
  • "powerStatus": "string",
  • "resource": "string",
  • "status": "string",
  • "task": 80
}

server/power/status

Return the cached power status of the requested 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
{
  • "error": "string",
  • "powerStatus": "string",
  • "resource": "string",
  • "status": "string",
  • "task": 80
}

server/power/stop

Stop the requested 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
{
  • "error": "string",
  • "powerStatus": "string",
  • "resource": "string",
  • "status": "string",
  • "task": 80
}

Template

This section of the API provides server template information. A template represents the operating system, management, and optionally the inclusion of a control panel as part of the server deployment.

server/template/details

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

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

server_type
any
Enum: "Cloud.VPS" "Cloud.VPS.WIN" "Cloud.Metal" "Cloud.Metal.WIN" "Bare.Metal" "Bare.Metal.GPU"
region_id
integer (RELATION_ID) ^[1-9]\d*\z
Example: region_id=54321

A valid id number (a positive integer).

zone_id
integer (RELATION_ID) ^[1-9]\d*\z
Example: zone_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
{
  • "available": true,
  • "control_panel": "string",
  • "management": "string",
  • "name": "string",
  • "os_bit": 12345,
  • "os_name": "string",
  • "os_type": "string",
  • "os_version": "string",
  • "region_id": 54321,
  • "server_type": "Cloud.VPS",
  • "type": "MachineTemplate",
  • "zone_id": 54321
}

server/template/list

Authorizations:
BearerAuthHTTPBasicAuth
query Parameters
available
boolean (BOOLEAN)
Default: 1

A boolean value (0 or 1).

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

A valid id number (a positive integer).

server_type
any
Enum: "Cloud.VPS" "Cloud.VPS.WIN" "Cloud.Metal" "Cloud.Metal.WIN" "Bare.Metal" "Bare.Metal.GPU"
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
}