Order VPS

POST

/vps/order

Order a new VPS. Be careful: the order is placed directly and the account is charged.

Creation is asynchronous: the response carries an order_id, not a VPS. Poll GET /orders/{order_id} until the order is processed, then the new instance shows up in GET /vps/.

Pick product_id from GET /vps/products and image_id from GET /vps/images. Unmanaged products need ssh_key_id or root_password. Managed products take neither.

customizations are desired totals, not extras above the package (a plan with 2 cores ordered as 3 is 3 cores). extra_software ids must match GET /vps/products availability for the chosen image and product. CloudLinux and Imunify360 must be ordered together. Extra software is billed here; installing it on the VPS is a later phase.

Request

Authorization

API Key

Add parameter in header

API-key

Example:

API-key: ********************

Header Params

Body Params application/jsonRequired

Example

{
    "product_id": 107,
    "image_id": 1,
    "hostname": "server.example.com",
    "ssh_key_id": 12,
    "customizations": {
        "disk": 60,
        "cores": 2,
        "ram": 4,
        "ipv4": 1,
        "snapshots": 1,
        "traffic": 3
    },
    "extra_software": [84, 134, 100],
    "jetbackup_storage": 5,
    "uplink_speed": 0,
    "ddos_protection": 0
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://mijn.host/api/v2/vps/order' \
--header 'Accept: application/json' \
--header 'User-Agent: my-application/1.0.0' \
--header 'API-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "product_id": 107,
    "image_id": 1,
    "hostname": "server.example.com",
    "ssh_key_id": 12,
    "customizations": {
        "disk": 60,
        "cores": 2,
        "ram": 4,
        "ipv4": 1,
        "snapshots": 1,
        "traffic": 3
    },
    "extra_software": [84, 134, 100],
    "jetbackup_storage": 5,
    "uplink_speed": 0,
    "ddos_protection": 0
}'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "status": 200,
    "status_description": "Request successful",
    "data": {
        "order_id": 10000
    }
}

🟠400Credit limit exceeded

🟠400Duplicate hostname

🟠400Wrong request method

🟠400SSL connection is required

🟠401No valid API key set

🟠401API key has expired

🟠401Remote IP address is not found in the API key whitelist

🔴500Error

Modified at 2026-09-01 15:50:57

List VPS products

List VPS instances