mirror of
https://github.com/mii443/vrchatapi-rust.git
synced 2025-08-22 23:55:33 +00:00
136 lines
4.2 KiB
Markdown
136 lines
4.2 KiB
Markdown
# \InstancesApi
|
|
|
|
All URIs are relative to *https://api.vrchat.cloud/api/1*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**get_instance**](InstancesApi.md#get_instance) | **GET** /instances/{worldId}:{instanceId} | Get Instance
|
|
[**get_instance_by_short_name**](InstancesApi.md#get_instance_by_short_name) | **GET** /instances/s/{shortName} | Get Instance By Short Name
|
|
[**get_short_name**](InstancesApi.md#get_short_name) | **GET** /instances/{worldId}:{instanceId}/shortName | Get Instance Short Name
|
|
[**send_self_invite**](InstancesApi.md#send_self_invite) | **POST** /instances/{worldId}:{instanceId}/invite | Send Self Invite
|
|
|
|
|
|
|
|
## get_instance
|
|
|
|
> crate::models::Instance get_instance(world_id, instance_id)
|
|
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 | Required | Notes
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
**world_id** | **String** | Must be a valid world ID. | [required] |
|
|
**instance_id** | **String** | Must be a valid instance ID. | [required] |
|
|
|
|
### Return type
|
|
|
|
[**crate::models::Instance**](Instance.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
|
|
## get_instance_by_short_name
|
|
|
|
> crate::models::Instance get_instance_by_short_name(short_name)
|
|
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 | Required | Notes
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
**short_name** | **String** | Must be a valid instance short name. | [required] |
|
|
|
|
### Return type
|
|
|
|
[**crate::models::Instance**](Instance.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
|
|
## get_short_name
|
|
|
|
> crate::models::InstanceShortNameResponse get_short_name(world_id, instance_id)
|
|
Get Instance Short Name
|
|
|
|
Returns an instance short name.
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Required | Notes
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
**world_id** | **String** | Must be a valid world ID. | [required] |
|
|
**instance_id** | **String** | Must be a valid instance ID. | [required] |
|
|
|
|
### Return type
|
|
|
|
[**crate::models::InstanceShortNameResponse**](InstanceShortNameResponse.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: text/plain, application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
|
|
## send_self_invite
|
|
|
|
> crate::models::Success send_self_invite(world_id, instance_id)
|
|
Send Self Invite
|
|
|
|
Sends an invite to the instance to yourself.
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Required | Notes
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
**world_id** | **String** | Must be a valid world ID. | [required] |
|
|
**instance_id** | **String** | Must be a valid instance ID. | [required] |
|
|
|
|
### Return type
|
|
|
|
[**crate::models::Success**](Success.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|