Get status and resource usage for a virtual server (VM)

Check the current status of a specific virtual server (VM), including whether it is running or stopped. It also returns detailed information about the server's resource usage such as CPU, memory, and disk space. This endpoint returns a 'requestId' for tracking operations, and 'vmid' and 'pid' as important identifiers for subsequent actions.

Path Parameters

vmid integer · min: 1 required Example

Unique vmid identifier

Headers

Accept Example

Content-Type Example

Responses

200

success boolean

timestamp string

requestId string

data object

401

error string

message string

code string

timestamp string

requestId string

429

error string

message string

retryAfter string

requestId string

GET https://cloud.hostup.se/api/vm/{vmid}/status

For AI assistants

cURL

curl -X GET "https://cloud.hostup.se/api/vm/15520/status" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response

{
  "success": true,
  "timestamp": "string",
  "requestId": "string",
  "data": {
    "vmid": "string",
    "node": "string",
    "name": "string",
    "status": "string",
    "uptime": 0,
    "cpu": 0,
    "cpus": 0,
    "maxcpu": 0,
    "mem": 0,
    "maxmem": 0,
    "disk": 0,
    "maxdisk": 0,
    "netin": 0,
    "netout": 0,
    "diskread": 0,
    "diskwrite": 0,
    "pid": 0,
    "os": "string",
    "pending_tasks": [
      "string"
    ]
  }
}

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "timestamp": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "vmid": {
          "type": "string"
        },
        "node": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "status": {
          "type": "string"
        },
        "uptime": {
          "type": "integer"
        },
        "cpu": {
          "type": "number"
        },
        "cpus": {
          "type": "integer"
        },
        "maxcpu": {
          "type": "integer"
        },
        "mem": {
          "type": "integer"
        },
        "maxmem": {
          "type": "integer"
        },
        "disk": {
          "type": "integer"
        },
        "maxdisk": {
          "type": "integer"
        },
        "netin": {
          "type": "integer"
        },
        "netout": {
          "type": "integer"
        },
        "diskread": {
          "type": "integer"
        },
        "diskwrite": {
          "type": "integer"
        },
        "pid": {
          "type": "integer"
        },
        "os": {
          "type": "string"
        },
        "pending_tasks": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}