v6 documentation is incomplete, want to contribute?

Get Instance Short Name

Returns an instance short name.

Requests made through this page are proxied through an intermediary server due to Cross-Origin Resource Sharing restrictions.

GET
/instances/{worldId}:{instanceId}/shortName
auth<token>

Auth Token via Cookie

In: cookie

Path Parameters

worldIdstring

Must be a valid world ID.

instanceIdstring

Must be a valid instance ID.

Response Body

application/json

application/json

curl -X GET "https://api.vrchat.cloud/api/1/instances/string:string/shortName"
{
  "secureName": "7eavhhng",
  "shortName": "02u7yz8j"
}

{
  "error": {
    "message": "\"Missing Credentials\"",
    "status_code": 401
  }
}