183 lines
5.4 KiB
Markdown
183 lines
5.4 KiB
Markdown
# InstancesApi
|
|
|
|
All URIs are relative to *https://api.vrchat.cloud/api/1*
|
|
|
|
| Method | HTTP request | Description |
|
|
|------------- | ------------- | -------------|
|
|
| [**closeInstance**](InstancesApi.md#closeInstance) | **DELETE** /instances/{worldId}:{instanceId} | Close Instance |
|
|
| [**createInstance**](InstancesApi.md#createInstance) | **POST** /instances | Create Instance |
|
|
| [**getInstance**](InstancesApi.md#getInstance) | **GET** /instances/{worldId}:{instanceId} | Get Instance |
|
|
| [**getInstanceByShortName**](InstancesApi.md#getInstanceByShortName) | **GET** /instances/s/{shortName} | Get Instance By Short Name |
|
|
| [**getRecentLocations**](InstancesApi.md#getRecentLocations) | **GET** /instances/recent | List Recent Locations |
|
|
| [**getShortName**](InstancesApi.md#getShortName) | **GET** /instances/{worldId}:{instanceId}/shortName | Get Instance Short Name |
|
|
|
|
|
|
<a name="closeInstance"></a>
|
|
# **closeInstance**
|
|
> Instance closeInstance(worldId, instanceId, hardClose, closedAt)
|
|
|
|
Close Instance
|
|
|
|
Close an instance or update the closedAt time when it will be closed. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-manage` permission.
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **worldId** | **String**| Must be a valid world ID. | [default to null] |
|
|
| **instanceId** | **String**| Must be a valid instance ID. | [default to null] |
|
|
| **hardClose** | **Boolean**| Whether to hard close the instance. Defaults to false. | [optional] [default to null] |
|
|
| **closedAt** | **Date**| The time after which users won't be allowed to join the instances. If omitted, the instance will be closed immediately. | [optional] [default to null] |
|
|
|
|
### Return type
|
|
|
|
[**Instance**](../Models/Instance.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="createInstance"></a>
|
|
# **createInstance**
|
|
> Instance createInstance(CreateInstanceRequest)
|
|
|
|
Create Instance
|
|
|
|
Create an instance
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **CreateInstanceRequest** | [**CreateInstanceRequest**](../Models/CreateInstanceRequest.md)| | |
|
|
|
|
### Return type
|
|
|
|
[**Instance**](../Models/Instance.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
<a name="getInstance"></a>
|
|
# **getInstance**
|
|
> Instance getInstance(worldId, instanceId)
|
|
|
|
Get Instance
|
|
|
|
Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances. If an invalid instanceId is provided, this endpoint will simply return \"null\"!
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **worldId** | **String**| Must be a valid world ID. | [default to null] |
|
|
| **instanceId** | **String**| Must be a valid instance ID. | [default to null] |
|
|
|
|
### Return type
|
|
|
|
[**Instance**](../Models/Instance.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="getInstanceByShortName"></a>
|
|
# **getInstanceByShortName**
|
|
> Instance getInstanceByShortName(shortName)
|
|
|
|
Get Instance By Short Name
|
|
|
|
Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances.
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **shortName** | **String**| Must be a valid instance short name. | [default to null] |
|
|
|
|
### Return type
|
|
|
|
[**Instance**](../Models/Instance.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="getRecentLocations"></a>
|
|
# **getRecentLocations**
|
|
> List getRecentLocations(n, offset)
|
|
|
|
List Recent Locations
|
|
|
|
Returns a list of recently visited locations.
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
|
|
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
|
|
|
|
### Return type
|
|
|
|
**List**
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="getShortName"></a>
|
|
# **getShortName**
|
|
> InstanceShortNameResponse getShortName(worldId, instanceId)
|
|
|
|
Get Instance Short Name
|
|
|
|
Returns an instance short name.
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **worldId** | **String**| Must be a valid world ID. | [default to null] |
|
|
| **instanceId** | **String**| Must be a valid instance ID. | [default to null] |
|
|
|
|
### Return type
|
|
|
|
[**InstanceShortNameResponse**](../Models/InstanceShortNameResponse.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|