add subdir
This commit is contained in:
ExilProductions
248
Apis/MiscellaneousApi.md
Normal file
248
Apis/MiscellaneousApi.md
Normal file
@@ -0,0 +1,248 @@
|
||||
# MiscellaneousApi
|
||||
|
||||
All URIs are relative to *https://api.vrchat.cloud/api/1*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
|------------- | ------------- | -------------|
|
||||
| [**getAssignedPermissions**](MiscellaneousApi.md#getAssignedPermissions) | **GET** /auth/permissions | Get Assigned Permissions |
|
||||
| [**getCSS**](MiscellaneousApi.md#getCSS) | **GET** /css/app.css | Download CSS |
|
||||
| [**getConfig**](MiscellaneousApi.md#getConfig) | **GET** /config | Fetch API Config |
|
||||
| [**getCurrentOnlineUsers**](MiscellaneousApi.md#getCurrentOnlineUsers) | **GET** /visits | Current Online Users |
|
||||
| [**getHealth**](MiscellaneousApi.md#getHealth) | **GET** /health | Check API Health |
|
||||
| [**getInfoPush**](MiscellaneousApi.md#getInfoPush) | **GET** /infoPush | Show Information Notices |
|
||||
| [**getJavaScript**](MiscellaneousApi.md#getJavaScript) | **GET** /js/app.js | Download JavaScript |
|
||||
| [**getPermission**](MiscellaneousApi.md#getPermission) | **GET** /permissions/{permissionId} | Get Permission |
|
||||
| [**getSystemTime**](MiscellaneousApi.md#getSystemTime) | **GET** /time | Current System Time |
|
||||
|
||||
|
||||
<a name="getAssignedPermissions"></a>
|
||||
# **getAssignedPermissions**
|
||||
> List getAssignedPermissions()
|
||||
|
||||
Get Assigned Permissions
|
||||
|
||||
Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**List**](../Models/Permission.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[authCookie](../README.md#authCookie)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
<a name="getCSS"></a>
|
||||
# **getCSS**
|
||||
> String getCSS(variant, branch)
|
||||
|
||||
Download CSS
|
||||
|
||||
Fetches the CSS code to the frontend React website.
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes |
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **variant** | **String**| Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management. | [optional] [default to public] [enum: internal, public] |
|
||||
| **branch** | **String**| Specifies which git branch the site should load frontend source code from. | [optional] [default to main] |
|
||||
|
||||
### Return type
|
||||
|
||||
**String**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/css, application/json
|
||||
|
||||
<a name="getConfig"></a>
|
||||
# **getConfig**
|
||||
> APIConfig getConfig()
|
||||
|
||||
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
|
||||
|
||||
[**APIConfig**](../Models/APIConfig.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
<a name="getCurrentOnlineUsers"></a>
|
||||
# **getCurrentOnlineUsers**
|
||||
> Integer getCurrentOnlineUsers()
|
||||
|
||||
Current Online Users
|
||||
|
||||
Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
**Integer**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
<a name="getHealth"></a>
|
||||
# **getHealth**
|
||||
> APIHealth getHealth()
|
||||
|
||||
Check API 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.
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**APIHealth**](../Models/APIHealth.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
<a name="getInfoPush"></a>
|
||||
# **getInfoPush**
|
||||
> List getInfoPush(require, include)
|
||||
|
||||
Show Information Notices
|
||||
|
||||
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.
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes |
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **require** | **String**| Tags to include (comma-separated). All of the tags needs to be present. | [optional] [default to null] |
|
||||
| **include** | **String**| Tags to include (comma-separated). Any of the tags needs to be present. | [optional] [default to null] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**List**](../Models/InfoPush.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[authCookie](../README.md#authCookie)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
<a name="getJavaScript"></a>
|
||||
# **getJavaScript**
|
||||
> String getJavaScript(variant, branch)
|
||||
|
||||
Download JavaScript
|
||||
|
||||
Fetches the JavaScript code to the frontend React website.
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes |
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **variant** | **String**| Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management. | [optional] [default to public] [enum: internal, public] |
|
||||
| **branch** | **String**| Specifies which git branch the site should load frontend source code from. | [optional] [default to main] |
|
||||
|
||||
### Return type
|
||||
|
||||
**String**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/javascript, application/json
|
||||
|
||||
<a name="getPermission"></a>
|
||||
# **getPermission**
|
||||
> Permission getPermission(permissionId)
|
||||
|
||||
Get Permission
|
||||
|
||||
Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as `/auth/permissions`.
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes |
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **permissionId** | **String**| Must be a valid permission ID. | [default to null] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Permission**](../Models/Permission.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[authCookie](../README.md#authCookie)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
<a name="getSystemTime"></a>
|
||||
# **getSystemTime**
|
||||
> Date getSystemTime()
|
||||
|
||||
Current System Time
|
||||
|
||||
Returns the current time of the API server. **NOTE:** The response type is not a JSON object, but a simple JSON string.
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
**Date**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
Reference in New Issue
Block a user