specification/openapi/components/requests/CreateInstanceRequest.yaml at main · vrchatapi/specification · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
title: CreateInstanceRequest
type: object
properties:
  ageGate:
    type: boolean
    default: false
  calendarEntryId:
    type: string
  canRequestInvite:
    type: boolean
    description: Makes a private instance invite+. A friends instance is rejected.
    default: false
  categoryId:
    $ref: ../schemas/InstanceCategoryID.yaml
  closedAt:
    type: string
    description: The time after which users won't be allowed to join the instance. This doesn't work for public instances.
    format: date-time
  contentSettings:
    $ref: ../schemas/InstanceContentSettings.yaml
  description:
    type: string
  displayName:
    type: string
  groupAccessType:
    $ref: ../schemas/GroupAccessType.yaml
  hardClose:
    type: boolean
    description: Currently unused, but will eventually be a flag to set if the closing of the instance should kick people.
    default: false
  instancePersistenceEnabled:
    type: boolean
    nullable: true
  inviteOnly:
    type: boolean
    default: false
  ownerId:
    $ref: ../schemas/InstanceOwnerId.yaml
  playerPersistenceEnabled:
    type: boolean
    nullable: true
  queueEnabled:
    type: boolean
    default: false
  region:
    $ref: ../schemas/InstanceRegion.yaml
  roleIds:
    type: array
    description: Group roleIds that are allowed to join if the type is "group" and groupAccessType is "member"
    items:
      $ref: ../schemas/GroupRoleID.yaml
  type:
    $ref: ../schemas/InstanceType.yaml
  vibeIds:
    type: array
    items:
      $ref: ../schemas/InstanceVibeID.yaml
  worldId:
    $ref: ../schemas/WorldID.yaml
required:
  - region
  - type
  - worldId