API Documentation

VPS Traffic

Returns the current month's bandwidth usage summary and a daily traffic log for a VPS.

Request

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

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": {
    "usage": {
      "month": "2026-03",
      "usage": {
        "total": 52428800,
        "in": 31457280,
        "out": 20971520
      },
      "limit": {
        "monthly": 10737418240,
        "additional": null,
        "remaining": 10684989440,
        "vmStatus": "normal"
      }
    },
    "log": {
      "month": "2026-03",
      "log": [
        {
          "date": "2026-03-25",
          "in": 10485760,
          "out": 7340032
        },
        {
          "date": "2026-03-26",
          "in": 12582912,
          "out": 8388608
        },
        {
          "date": "2026-03-27",
          "in": 8388608,
          "out": 5242880
        }
      ]
    }
  }
}

Usage Fields

Field Type Description
month string Month in YYYY-MM format
usage.total number Total bytes transferred this month
usage.in number Inbound bytes
usage.out number Outbound bytes

Limit Fields

Field Type Description
monthly number Monthly bandwidth allowance in bytes
additional number | null Additional purchased bandwidth in bytes
remaining number Remaining bandwidth in bytes
vmStatus string normal or throttled

Traffic Log Entry

Field Type Description
date string Date in YYYY-MM-DD format
in number Inbound bytes for the day
out number Outbound bytes for the day

Example

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

MCP

This data is also available via the get_vm_traffic MCP tool.