Modbot Docs
APIAPI referenceHealth

Get machine usage

GET/api/health/machine

Processor use, memory and disk activity over the last half hour. Every figure is this server's own use of the machine, not the whole machine's: in a container that is what the operator sized and pays for, and it is the only thing Modbot can measure without being told about its host.

A figure is null on a host where it cannot be read honestly — the disk counters are Linux-only, and a memory limit exists only where something sets one. Null means unavailable, never zero.

Readings are kept in memory only. Nothing here is stored, and the window is empty for the first few seconds after a restart: processor use and disk activity are rates, and a rate needs two readings.

Needs the ViewOperationalLog permission.

AuthorizationBearer <token>

An API key, made on Settings, API keys. Every key starts with mbk_.

In: header

Response Body

application/json

application/problem+json

application/problem+json

curl -X GET "https://example.com/api/health/machine"
{  "sampleSeconds": 0,  "windowMinutes": 0,  "processors": 0,  "memoryLimitBytes": null,  "now": "2019-08-24T14:15:22Z",  "points": [    {      "at": "2019-08-24T14:15:22Z",      "processorPercent": null,      "memoryBytes": null,      "diskReadBytesPerSecond": null,      "diskWrittenBytesPerSecond": null    }  ]}

Modbot is not endorsed by or affiliated with VRChat Inc. or Discord Inc. VRChat is a trademark of VRChat Inc. Discord is a trademark of Discord Inc. SteamVR is a trademark of Valve Corporation. Windows is a trademark of Microsoft Corporation. Docker is a trademark of Docker, Inc. PostgreSQL is a trademark of the PostgreSQL Community Association of Canada. Railway is a trademark of Railway Corp. Other names are trademarks of their respective owners; see Legal. Modbot and its logo are trademarks of the Modbot project. Open source under AGPL-3.0.