Get VRChat gate health
/api/health/gateWhether Modbot is reaching VRChat, and whether that is a problem. status is the load-bearing field. RateLimited and WafBlocked both stop traffic and look identical from outside, and they mean opposite things: a cold stop is spec 4.3.1 working as designed and recovers on its own, while a WAF block needs an egress proxy and will not clear by itself.
Available to any signed-in account. A moderator whose action did nothing needs to be able to tell waiting from broken.
An API key, made on Settings, API keys. Every key starts with mbk_.
In: header
Response Body
application/json
application/problem+json
curl -X GET "https://example.com/api/health/gate"{ "state": "string", "status": "Working", "headline": "string", "coldStoppedBuckets": 0, "coldStopEndsAt": null, "alertingBuckets": 0, "signInWait": null, "lastSignedInAt": null, "signInsInLastHour": 0, "signInLimit": 0}Get the Discord bot's state GET
Where the Discord bot is: `NotConfigured`, `Connecting`, `Connected`, `Disconnected` or `Failed`; null when this server runs no bot. The word alone, for the Integrations page, so it needs ManageSettings rather than ViewOperationalLog. The bot's errors and counts stay in the sync health read. Needs the `ManageSettings` permission.
Get machine usage GET
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.