Deploy new server

POSThttps://api.vpsbg.eu/v1/servers

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: Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

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.

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.

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

Request samples

Responses

The 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.(201)

Validation error. The error is specified in the response.(422)

HTTP Code: 201

Content Type : JSONapplication/json

data

array[object (Server) {13}]

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

locked

boolean

required

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

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.

server_image

object

required

ip_addresses

object

required

addons

array [object {2}]

required

Not configured

Last modified: 18 days ago