VPS details - my.host API

Request

Authorization

API Key

Add parameter in header

API-key

Example:

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

or

Path Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location 'https://mijn.host/api/v2/vps/12345' \
--header 'Accept: application/json' \
--header 'User-Agent: my-application/1.0.0' \
--header 'API-key: <api-key>' \
--header 'Content-Type: application/json'

Responses

🟢200Success

application/json

VPS details

Bodyapplication/json

Example

{
    "status": 200,
    "status_description": "Request successful.",
    "data": {
        "id": 12345,
        "name": "my-vps",
        "end_date": "2026-03-13",
        "status": "Active",
        "status_id": 1,
        "specifications": {
            "network": {
                "v4": {
                    "ip": [
                        "1.2.3.4"
                    ]
                },
                "v6": {
                    "ip": [
                        "2001:db8::1"
                    ]
                }
            },
            "os": "Ubuntu 22.04",
            "power_status": "Running",
            "cpu": {
                "total": 2
            },
            "memory": {
                "total": 4
            },
            "diskspace": {
                "total": 80
            },
            "bandwidth": 1000,
            "used_bandwidth": 10.5
        },
        "task": {
            "actid": 2407,
            "action": "Rebuilding VPS",
            "status_text": "Installing the OS",
            "progress": "40%"
        },
        "locked": {
            "reason": "VPS is being rebuilt, hence no actions are allowed to be performed on this VPS"
        }
    }
}

🟠400Wrong request method

🟠401SSL connection is required

🔴500No valid VPS ID provided

🟠400No access to this VPS

🟠401No valid API key set

🟠401API key has expired

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

🔴500Error