Instances
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.
Authorization
authCookie auth<token>
Auth Token via Cookie
In: cookie
Path Parameters
worldId*string
Must be a valid world ID.
instanceId*string
Must be a valid instance ID.
Query Parameters
hardClose?boolean
Whether to hard close the instance. Defaults to false.
closedAt?string
The time after which users won't be allowed to join the instances. If omitted, the instance will be closed immediately.
Format
date-timeResponse Body
application/json
application/json
application/json
application/json
curl -X DELETE "https://api.vrchat.cloud/api/1/instances/string:string"{
"active": true,
"ageGate": true,
"calendarEntryId": "string",
"canRequestInvite": true,
"capacity": 8,
"clientNumber": "string",
"closedAt": "2019-08-24T14:15:22Z",
"contentSettings": {
"drones": true,
"emoji": true,
"pedestals": true,
"prints": true,
"props": true,
"stickers": true
},
"creatorId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
"displayName": "string",
"friends": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
"full": false,
"gameServerVersion": 0,
"groupAccessType": "members",
"hardClose": true,
"hasCapacityForYou": true,
"hidden": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
"id": "12345~hidden(usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469)~region(eu)~nonce(27e8414a-59a0-4f3d-af1f-f27557eb49a2)",
"instanceId": "12345~hidden(usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469)~region(eu)~nonce(27e8414a-59a0-4f3d-af1f-f27557eb49a2)",
"instancePersistenceEnabled": true,
"location": "wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd:12345~hidden(usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469)~region(eu)~nonce(27e8414a-59a0-4f3d-af1f-f27557eb49a2)",
"n_users": 6,
"name": "12345",
"nonce": "string",
"ownerId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
"permanent": false,
"photonRegion": "eu",
"platforms": {
"android": 1,
"ios": 1,
"standalonewindows": 5
},
"playerPersistenceEnabled": true,
"private": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
"queueEnabled": true,
"queueSize": 6,
"recommendedCapacity": 6,
"region": "us",
"roleRestricted": true,
"secureName": "7eavhhng",
"shortName": "02u7yz8j",
"strict": true,
"tags": [
"language_eng",
"language_jpn",
"show_social_rank"
],
"type": "hidden",
"userCount": 6,
"users": [
{
"ageVerificationStatus": "18+",
"ageVerified": true,
"allowAvatarCopying": true,
"bio": "string",
"bioLinks": [
"string"
],
"currentAvatarImageUrl": "https://api.vrchat.cloud/api/1/file/file_ae46d521-7281-4b38-b365-804b32a1d6a7/1/file",
"currentAvatarTags": [
"string"
],
"currentAvatarThumbnailImageUrl": "https://api.vrchat.cloud/api/1/image/file_aae83ed9-d42d-4d72-9f4b-9f1e41ed17e1/1/256",
"date_joined": "2019-08-24T14:15:22Z",
"developerType": "internal",
"displayName": "string",
"friendKey": "string",
"id": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
"imageUrl": "string",
"isFriend": true,
"last_activity": "2019-08-24T14:15:22Z",
"last_mobile": "2019-08-24T14:15:22Z",
"last_platform": "standalonewindows",
"platform": "standalonewindows",
"profilePicOverride": "string",
"profilePicOverrideThumbnail": "string",
"pronouns": "string",
"state": "active",
"status": "active",
"statusDescription": "string",
"tags": [
"string"
],
"userIcon": "string"
}
],
"world": {
"authorId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
"authorName": "string",
"capacity": 8,
"created_at": "2019-08-24T14:15:22Z",
"defaultContentSettings": {
"drones": true,
"emoji": true,
"pedestals": true,
"prints": true,
"props": true,
"stickers": true
},
"description": "string",
"favorites": 12024,
"featured": false,
"heat": 5,
"id": "wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd",
"imageUrl": "string",
"instances": [
[
null,
null
]
],
"labsPublicationDate": "none",
"name": "string",
"namespace": "string",
"occupants": 47,
"organization": "vrchat",
"popularity": 8,
"previewYoutubeId": "string",
"privateOccupants": 1,
"publicOccupants": 46,
"publicationDate": "none",
"recommendedCapacity": 4,
"releaseStatus": "public",
"storeId": "esto_713b247d-2b5d-41a0-bba3-50db28dc1498",
"tags": [
"string"
],
"thumbnailImageUrl": "string",
"udonProducts": [
"prod_c1644b5b-3ca4-45b4-97c6-a2a0de70d469"
],
"unityPackages": [
{
"assetUrl": "https://api.vrchat.cloud/api/1/file/file_cd0caa7b-69ba-4715-8dfe-7d667a9d2537/65/file",
"assetUrlObject": {},
"assetVersion": 4,
"created_at": "2020-09-10T06:13:27.777Z",
"id": "unp_52b12c39-4163-457d-a4a9-630e7aff1bff",
"impostorUrl": "string",
"impostorizerVersion": "0.17.0",
"performanceRating": "Excellent",
"platform": "standalonewindows",
"pluginUrl": "",
"pluginUrlObject": {},
"scanStatus": "string",
"unitySortNumber": 20180414000,
"unityVersion": "2022.3.6f1",
"variant": "string",
"worldSignature": "AHiPAWerwCpeYrxDthF5TU2SdUWEWnm43UAn8PKRXlS8k8tVRQ=="
}
],
"updated_at": "2019-08-24T14:15:22Z",
"urlList": [
"string"
],
"version": 68,
"visits": 9988675
},
"worldId": "wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd"
}{
"error": {
"message": "\"Missing Credentials\"",
"status_code": 401
}
}{
"error": {
"message": "You're not allowed to close an already closed instance․",
"status_code": 403
}
}{
"error": {
"message": "\"Instance not found\"",
"status_code": 404
}
}