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

Body Params application/json

Example

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

Request Code 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

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",
                    "fingerprint": "c3:02:91:64:1f:e3:da:4b:7e:9e:33e:14:qf:4d:39:73",
                    "key": "string",
                    "servers": [
                        {
                            "id": 0,
                            "hostname": "string",
                            "ssh_keys_count": 1,
                            "root_password_login_enabled": true
                        }
                    ]
                }
            ],
            "app_getting_started": "string"
        }
    ]
}

🟠400Bad request (specified in the response)

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

🔴500Server Error