Icon for VRChat.community
VRChat.communityAPI documentation, SDKs, and more
Metrics
Discord
Miscellaneous

Check API Health

GET
/health

Gets the overall health status, the server name, and the current build version tag of the API.

DEPRECATED: VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.

Response Body

application/json

curl -X GET "https://api.vrchat.cloud/api/1/health"
{
  "buildVersionTag": "master-build-2021-06-24-fred-drakeshoot",
  "ok": true,
  "serverName": "prod-api-green-marsh-dgt"
}

Current Online Users GET

Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.

Show Information Notices GET

IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version. `include` is used to query what Information Pushes should be included in the response. If include is missing or empty, then no notices will normally be returned. This is an "any of" search. `require` is used to limit what Information Pushes should be included in the response. This is usually used in combination with `include`, and is an "all of" search.