v1
latestOpenAPI 3.0.42026-07-23366.9 KBCreates a room instance on the server.
Request body
Unique ID of the room instance. This ID is used to identify the room in the server.
Secret used for authenticating Simulator connections.
Maximum number of clients allowed to connect to the room instance.
Maximum number of entities allowed to be created in the room instance.
Maximum number of queries that each client can have active at any time.
Name of the schema to be used for the room instance.
How long (in seconds) the schema should be cached in the server before being removed.
URLs of the schemas to be used for the room instance.
List of schemas to be used for the room instance.
How long (in milliseconds) the server should wait before closing the connection to a client that hasn't sent any data.
Whether to enable debug streams for the room instance.
Frequency (Hz) at which the server should send updates to clients.
Frequency (Hz) at which the server expects to receive updates from clients.
Minimum displacement distance for a query to be considered changed.
How long (in seconds) the server should wait before removing a room instance that has no active clients.
ID of the project to which the room instance belongs.
Key-Value Pair (KVP) data associated with the room instance.
Private Key-Value Pair (KVP) data associated with the room instance.
Tags associated with the room instance.
Timestamp indicating when the room instance was created.
Comma-separated list of host authority features. Valid values are "create-entities" and "validate-connection". Example "create-entities,validate-connection"
Response
Room was created successfully
ID of the room instance as assigned by the server.