3.0 KiB
\SystemApi
All URIs are relative to https://api.vrchat.cloud/api/1
| Method | HTTP request | Description |
|---|---|---|
| get_config | GET /config | Fetch API Config |
| get_current_online_users | GET /visits | Current Online Users |
| get_health | GET /health | Check API Health |
| get_system_time | GET /time | Current System Time |
get_config
crate::models::Config get_config() Fetch API Config
API config contains configuration that the clients needs to work properly. Currently the most important value here is clientApiKey which is used for all other API endpoints.
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_current_online_users
i32 get_current_online_users() Current Online Users
Returns in plain format the number of currently online users. NOTE: The response type is not of JSON, but is an integer in plain ASCII format.
Parameters
This endpoint does not need any parameter.
Return type
i32
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_health
crate::models::InlineResponse2002 get_health() Check API Health
Gets the overall health status, the server name, and the current build version tag of the API.
Parameters
This endpoint does not need any parameter.
Return type
crate::models::InlineResponse2002
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_system_time
String get_system_time() Current System Time
Returns in plain format the current time of the API server. NOTE: The response type is not of JSON, but is a string in plain ASCII format.
Parameters
This endpoint does not need any parameter.
Return type
String
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]