Metrics

Updated Nov 19, 2026 Markdown

GET /api/v1/accounts/{username}/metrics

Get Account Metrics

Get historical resource usage metrics for an account.

Path parameters:

Name Type Required Notes
username string yes —

Query parameters:

Name Type Required Notes
period string no pattern=^(24h|7d|30d)$

Responses:

Status Schema Description
200 object Successful Response
422 HTTPValidationError Validation Error

Response example (200):

JSON
{}

cURL example:

shell
curl -X GET \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/accounts/{username}/metrics

GET /api/v1/system/metrics

Get Server Metrics

Get historical server-wide resource usage metrics.

Query parameters:

Name Type Required Notes
period string no pattern=^(24h|7d|30d)$

Responses:

Status Schema Description
200 object Successful Response
422 HTTPValidationError Validation Error

Response example (200):

JSON
{}

cURL example:

shell
curl -X GET \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/system/metrics

GET /api/v1/system/server-info

Server hardware and software inventory

Identity (OS, kernel, virtualisation, vendor, board, BIOS, time sync, security module), CPU (model, topology, frequencies, caches, flags, vulnerabilities), memory modules and slots, disks with their partitions and SMART health, network interfaces, gateways, DNS and listening ports, installed stack versions, PCI devices and failed systemd units. Collected once and kept: an answer older than ten minutes is returned with refreshing: true while a new collection runs; refresh=true waits for a new one.

Query parameters:

Name Type Required Notes
refresh boolean no —

Responses:

Status Schema Description
200 ApiSuccess_ServerInventory_ Successful Response
422 HTTPValidationError Validation Error

Response example (200):

JSON
{
  "data": {
    "collect_ms": 0,
    "collected_at": 0.0,
    "cpu": "...",
    "health": "...",
    "memory": "...",
    "network": "...",
    "pci_devices": [
      "..."
    ],
    "refreshing": false,
    "software": [
      "..."
    ],
    "storage": "...",
    "system": "..."
  },
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell
curl -X GET \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/system/server-info

GET /api/v1/system/server-info/live

Live server readings

Uptime, load, CPU (total, per CPU, time categories, frequency, context switches and interrupts per second), memory, swap, file systems with inode use, disk and network throughput, RAID arrays, temperature and fan sensors, logged-in sessions, pressure stall information, TCP connection states and file handles. Rates are measured between this call and the previous one (or a half-second second reading); calls less than a second apart share one answer.

Responses:

Status Schema Description
200 ApiSuccess_ServerLive_ Successful Response

Response example (200):

JSON
{
  "data": {
    "cpu": "...",
    "disk_io": [
      "..."
    ],
    "file_handles": "...",
    "filesystems": [
      "..."
    ],
    "interval_seconds": 0.0,
    "load": "...",
    "memory": "...",
    "net_io": [
      "..."
    ],
    "pressure": [
      "..."
    ],
    "raid_arrays": [
      "..."
    ],
    "sampled_at": 0.0,
    "sensors": [
      "..."
    ],
    "sessions": [
      "..."
    ],
    "swap": "...",
    "tcp_states": [
      "..."
    ],
    "uptime_seconds": 0.0
  },
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell
curl -X GET \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/system/server-info/live

GET /api/v1/system/server-info/processes

Server process table

Every user-space process (kernel threads are counted in the summary only) with owner, command line (first 256 characters), state, CPU share of the whole machine since the previous call, memory, threads and start time, busiest first; limit caps the rows (truncated: true when more exist).

Query parameters:

Name Type Required Notes
limit integer no minimum=1; maximum=3000

Responses:

Status Schema Description
200 ApiSuccess_ServerProcesses_ Successful Response
422 HTTPValidationError Validation Error

Response example (200):

JSON
{
  "data": {
    "interval_seconds": 0.0,
    "limit": 0,
    "processes": [
      "..."
    ],
    "sampled_at": 0.0,
    "summary": "...",
    "truncated": false
  },
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell
curl -X GET \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/system/server-info/processes
Still Need Help?

Our support team is here around the clock for anything you can't find above.