API Documentation

VPS Monitoring

Returns CPU, memory, and ping history data for a VPS instance, along with downtime incident statistics.

Monitoring must be enabled on the server for timing data to be collected.

Request

GET /api/v1/vps/{id}/monitoring

Required scope: vps:read

Path Parameters

Parameter Type Description
id string The VPS ID

Headers

Header Required Value
Authorization Yes Bearer YOUR_API_KEY

Response

{
  "data": {
    "timings": [
      {
        "date": "2026-03-27T12:00:00Z",
        "cpu": 12.5,
        "mem": 42.3,
        "ping": 1.2
      },
      {
        "date": "2026-03-27T12:05:00Z",
        "cpu": 8.1,
        "mem": 41.8,
        "ping": 1.1
      }
    ],
    "incidents": {
      "statistic": {
        "LAST_24_HOURS": {
          "downtime": 0,
          "availability": 100,
          "incidents": 0,
          "longestIncident": 0,
          "averageIncident": 0
        },
        "LAST_7_DAYS": {
          "downtime": 120,
          "availability": 99.98,
          "incidents": 1,
          "longestIncident": 120,
          "averageIncident": 120
        }
      },
      "incidents": [
        {
          "start": "2026-03-22T03:15:00Z",
          "end": "2026-03-22T03:17:00Z",
          "downtime": 120,
          "type": "PING_TIMEOUT"
        }
      ]
    }
  }
}

Timings Fields

Field Type Description
date string ISO 8601 timestamp
cpu number CPU usage percentage (0–100)
mem number Memory usage percentage (0–100)
ping number Ping latency in milliseconds

Incident Statistics

Statistics are provided for multiple time periods: LAST_24_HOURS, LAST_7_DAYS, LAST_14_DAYS, LAST_30_DAYS, LAST_90_DAYS, LAST_180_DAYS.

Field Type Description
downtime number Total downtime in seconds
availability number Uptime percentage (0–100)
incidents number Number of downtime incidents
longestIncident number Longest incident in seconds
averageIncident number Average incident duration in seconds

Incident Events

Field Type Description
start string ISO 8601 start time
end string | null ISO 8601 end time (null if ongoing)
downtime number Duration in seconds
type string PING_TIMEOUT or VM_STOPPED

Example

curl -X GET "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/monitoring" \
  -H "Authorization: Bearer YOUR_API_KEY"

MCP

This data is also available via the get_vm_monitoring MCP tool.