Deploy new server - VPSBG's dev hub

This endpoints creates a new order for a server and pays it off-session using your account's balance or performs a payment directly from your saved card.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

string

required

Default:

application/json

Body Params application/json

name

required

Hostname of the server.

One of

string

array[string]

For single instances

plan

string

required

Plan's key.

Example:

cloud-vps-2gb

billing_cycle

integer

required

Billing cycle of the service.

>= 1<= 24

Example:

image_id

integer | null

optional

Image ID of the OS or App Template you would like to deploy.

snapshot_id

integer | null

optional

You can specify snapshot ID from which you want to deploy the new server. If image_id is specified, snapshot_id and backup_id are not being used.

backup_id

integer | null

optional

You can specify backup ID from which you want to deploy the new server. If image_id is specified, snapshot_id and backup_id are not being used.

primary_iso_id

integer | null

optional

You can specify the primary ISO file ID from which your server will boot.

secondary_iso_id

integer | null

optional

You can specify the secondary ISO file ID which will be mounted alongside your primary ISO.

password

string | null

optional

If ssh_keys is not specified, you can set the root password for your new server.

ssh_keys

array[integer] | null

optional

Array of SSH key ID's to be installed on the server.

backups

boolean | null

optional

Automatic backups addon. Additional charge will occur. Your server will have weekly backups (retention 3 weeks).

extra_ipv4

integer | null

optional

Additional IPv4 addresses. Will activate new Floating IP addresses and will attach them to the new server.

Example:

extra_ipv4_ddos

integer | null

optional

Additional DDoS-Protected IPv4 addresses. Will activate new Floating IP addresses and will attach them to the new server.

Example:

extra_ipv6

integer | null

optional

Additional IPv6 addresses. Will activate new Floating IP addresses and will attach them to the new server.

cpanel

string | null

optional

Specify if you want a cPanel license for your server. Available licenses: cpanel-admin-5, cpanel-pro-30, cpanel-plus-50 or cpanel-premier-100. For pricing, please refer to our product page.

Example:

cpanel-admin-5

bandwidth

string | null

optional

Specify if you want unmetered bandwidth for your server. Available options: 100mbps-unmetered or 1gbps-unmetered. For pricing, please refer to our product page.

Example:

100mbps-unmetered

microsoft_rds_sal

integer | null

optional

Number of Microsoft RDS SALs you would like to purchase. The license type is Per User - users using RDS on your Windows Server. For pricing, please refer to our product page.

microsoft_office_sal

integer | null

optional

Number of Microsoft Office (365) SALs you would like to purchase. The license type is Per User - users using Office (365) on your Windows Server. For pricing, please refer to our product page.

promo_code

string | null

optional

Specify promotional code, if you have one.

Example

{
    "name": "new_server",
    "plan": "cloud-vps-2gb",
    "billing_cycle": 3,
    "image_id": 73,
    "password": "fCm%5D&8Zc24rh"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201The server was created successfully. Please bear in mind that in some cases, your server might be returned in status Processing as all servers are processed in a queue. You can check the server data at a later point using the provided ID.

application/json

Body

data

array[object (Server) {26}]

optional

integer

required

Internal ID of the server.

Example:

2864

hostname

string

required

Actual hostname installed on the server.

Example:

ubuntu-2gb

billing_cycle

integer

required

Example:

plan

object

required

status

string

required

This is the billing status of the server. It does not represent the technical status of the server - running, stopped, etc.

Examples:

active processing suspended terminated

running

boolean | null

optional

virtualization

string

required

Example:

kvm

promo_code

string | null

optional

Latest used promo code.

renew_amount

number

required

The amount needed to renew your server for the current period.

renew_amount_with_vat

number

required

Renew amount with vat if applicable.

locked

boolean

required

The server might be locked in some scenarios like creating a snapshot, backup or other operation.

locked_at

string | null

optional

lock_reason

string | null

optional

created_at

string

required

Example:

2024-08-29T14:21:54.000000Z

expiry_at

string

required

Example:

2024-10-27T11:03:10.000000Z

potential_expiry_at

string

required

Accounts for unpaid or processing renew Orders.

Example:

2024-11-27T11:03:10.000000Z

auto_renew

boolean

required

If set to true, the server will be renewed using funds from your account balance or saved credit/credit cards.

show_smtp_unblock_form

boolean

required

server_image

object

required

ip_addresses

array[object (IP address) {10}]

required

addons

array [object {8}] | null

optional

cancel_request

optional

settings

object

required

root_password_login_enabled

boolean

required

Default:

true

ssh_keys

array [object {3}]

required

app_getting_started

string | null

optional

App template getting started text. Shown only if "include" contains app_getting_started.

Example

{
    "data": [
        {
            "id": 2864,
            "hostname": "ubuntu-2gb",
            "billing_cycle": 1,
            "plan": {
                "id": 104,
                "type": "cloud-vps",
                "key": "string",
                "name": "cloud-vps-2gb",
                "vcpus": 2,
                "memory": 2,
                "disk": 50,
                "bandwidth": 5,
                "minimum_billing_cycle": 1,
                "plan_with_more_disk": 0,
                "plan_with_more_memory": 0,
                "available": true,
                "price": 100,
                "price_with_vat": 120
            },
            "status": "active",
            "running": true,
            "virtualization": "kvm",
            "promo_code": "string",
            "renew_amount": 0,
            "renew_amount_with_vat": 0,
            "locked": true,
            "locked_at": "string",
            "lock_reason": "string",
            "created_at": "2024-08-29T14:21:54.000000Z",
            "expiry_at": "2024-10-27T11:03:10.000000Z",
            "potential_expiry_at": "2024-11-27T11:03:10.000000Z",
            "auto_renew": true,
            "show_smtp_unblock_form": true,
            "server_image": {
                "id": 73,
                "name": "Ubuntu 22.04",
                "group": {
                    "name": "Ubuntu",
                    "type": "os",
                    "key": "ubuntu"
                }
            },
            "ip_addresses": [
                {
                    "id": 417,
                    "ip_address": "87.120.37.46",
                    "prefix": 32,
                    "version": 4,
                    "type": "public",
                    "main": true,
                    "ddos_protected": true,
                    "floating_ip": {
                        "id": 205,
                        "status": "active",
                        "ip": "87.120.37.47",
                        "server_id": 2478,
                        "expiry": "2023-07-31T21:00:00.000000Z",
                        "ddos": 0
                    },
                    "ptr": {
                        "{IP_ADDRESS}": "example.com"
                    },
                    "assigned_on": "string"
                }
            ],
            "addons": [
                {
                    "id": 0,
                    "name": "100mbps-unmetered",
                    "status": "active",
                    "quantity": 1,
                    "amount": 50,
                    "amount_with_vat": 60,
                    "created_at": "2025-01-16 14:29:56",
                    "ended_at": "string"
                }
            ],
            "cancel_request": {
                "id": 1,
                "now": 1,
                "reason": "string",
                "created_at": "string"
            },
            "settings": {
                "renew_enabled": true,
                "snapshots_enabled": true
            },
            "root_password_login_enabled": true,
            "ssh_keys": [
                {
                    "id": 0,
                    "name": "string",
                    "key": "string"
                }
            ],
            "app_getting_started": "string"
        }
    ]
}

🟠422Validation error. The error is specified in the response.

🔴500Server Error