Rooms

Rooms related operations

Creates a room instance on the server.

post

http://127.0.0.1:64001http://127.0.0.1:32004

/add

Authorizations

rs_auth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

UniqueIDinteger · int64 · min: 1Required

Unique ID of the room instance. This ID is used to identify the room in the server.

Secretstring · min: 4 · max: 128Required

Secret used for authenticating Simulator connections.

MaxClientsinteger · min: 1 · max: 65535Required

Maximum number of clients allowed to connect to the room instance.

Default: 10

MaxEntitiesinteger · min: 1Required

Maximum number of entities allowed to be created in the room instance.

Default: 65534

MaxQueriesPerClientinteger · min: 1Required

Maximum number of queries that each client can have active at any time.

Default: 15

SchemaNamestringOptional

Name of the schema to be used for the room instance.

Default: ""

SchemaTimeoutinteger · min: 1Optional

How long (in seconds) the schema should be cached in the server before being removed.

Default: 60

SchemaUrlsstring[]Optional

URLs of the schemas to be used for the room instance.

Default: []

Schemasstring[]Optional

List of schemas to be used for the room instance.

Default: []

DisconnectTimeoutinteger · uint32 · min: 1Required

How long (in milliseconds) the server should wait before closing the connection to a client that hasn't sent any data.

Default: 5000

DebugStreamsbooleanOptional

Whether to enable debug streams for the room instance.

Default: false

SendFrequencyinteger · min: 1 · max: 256Required

Frequency (Hz) at which the server should send updates to clients.

Default: 20

RecvFrequencyinteger · uint8 · min: 1 · max: 255Required

Frequency (Hz) at which the server expects to receive updates from clients.

Default: 60

MinQueryDistancenumber · floatOptional

Minimum displacement distance for a query to be considered changed.

Default: 0.01

CleanupTimeoutinteger · min: 1Required

How long (in seconds) the server should wait before removing a room instance that has no active clients.

Default: 5

ProjectIDstringRequired

ID of the project to which the room instance belongs.

Tagsstring[]Optional

Tags associated with the room instance.

Createdstring · date-timeOptional

Timestamp indicating when the room instance was created.

HostAuthoritystringOptional

Comma-separated list of host authority features. Valid values are "create-entities" and "validate-connection". Example "create-entities,validate-connection"

Default: ""

Responses

200

Room was created successfully

application/json

400

Bad request; invalid or missing parameters

application/json

401

Unauthorized; invalid authentication token

500

Internal Replication Server error

application/json

503

Service unavailable; server is busy or overloaded

application/json

post

/add

HTTPcURLJavaScriptPython

POST /add HTTP/1.1
Host: 127.0.0.1:64001
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 474

{
  "UniqueID": 1,
  "Secret": "text",
  "MaxClients": 10,
  "MaxEntities": 65534,
  "MaxQueriesPerClient": 15,
  "SchemaName": "",
  "SchemaTimeout": 60,
  "SchemaUrls": [
    "text"
  ],
  "Schemas": [
    "text"
  ],
  "DisconnectTimeout": 5000,
  "DebugStreams": false,
  "SendFrequency": 20,
  "RecvFrequency": 60,
  "MinQueryDistance": 0.01,
  "CleanupTimeout": 5,
  "ProjectID": "text",
  "KVP": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "PrivateKVP": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "Tags": [
    "text"
  ],
  "Created": "2025-12-12T12:11:14.970Z",
  "HostAuthority": ""
}

{
  "RoomID": 1,
  "Secret": "text"
}

Closes a room instance on the server.

post

http://127.0.0.1:64001http://127.0.0.1:32004

/remove

Authorizations

rs_auth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

RoomIDinteger · uint16 · min: 1 · max: 65535Required

ID of the room instance as assigned by the server.

Responses

200

Room was closed successfully

No content

404

Room to be closed was not found

application/json

500

Internal Replication Server error

application/json

post

/remove

HTTPcURLJavaScriptPython

POST /remove HTTP/1.1
Host: 127.0.0.1:64001
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 12

{
  "RoomID": 1
}

No content

Fetches the list of rooms on the server.

get

http://127.0.0.1:64001http://127.0.0.1:32004

/get

Authorizations

rs_auth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

List of rooms was fetched successfully

application/json

500

Internal Replication Server error

application/json

get

/get

HTTPcURLJavaScriptPython

GET /get HTTP/1.1
Host: 127.0.0.1:64001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "Rooms": [
    {
      "UniqueID": 1,
      "ID": 1,
      "MaxClients": 1,
      "SchemaName": "text",
      "ConnectionCount": 1,
      "LastCheckTime": "2025-12-12T12:11:14.970Z",
      "ProjectID": "text",
      "KVP": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "PrivateKVP": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "Tags": [
        "text"
      ],
      "CreatedAt": "2025-12-12T12:11:14.970Z",
      "Secret": "text"
    }
  ]
}

Sets the Key-Value (KVP) data for a room instance.

post

http://127.0.0.1:64001http://127.0.0.1:32004

/kv

Authorizations

rs_auth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

RoomIDinteger · uint16 · min: 1 · max: 65535Required

ID of the room instance as assigned by the server.

Responses

200

KVP data was set successfully

application/json

404

Room to set KVP data for was not found

application/json

500

Internal Replication Server error

application/json

post

/kv

HTTPcURLJavaScriptPython

POST /kv HTTP/1.1
Host: 127.0.0.1:64001
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "RoomID": 1,
  "Data": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "RoomID": 1
}

Sets the Private Key-Value Pair (KVP) data for a room instance.

post

http://127.0.0.1:64001http://127.0.0.1:32004

/pkv

Authorizations

rs_auth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

RoomIDinteger · uint16 · min: 1 · max: 65535Required

ID of the room instance as assigned by the server.

Responses

200

Private KVP data was set successfully

application/json

404

Room to set Private KVP data for was not found

application/json

500

Internal Replication Server error

application/json

post

/pkv

HTTPcURLJavaScriptPython

POST /pkv HTTP/1.1
Host: 127.0.0.1:64001
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "RoomID": 1,
  "Data": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "RoomID": 1
}

Sets the tags for a room instance.

post

http://127.0.0.1:64001http://127.0.0.1:32004

/tags

Authorizations

rs_auth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

RoomIDinteger · uint16 · min: 1 · max: 65535Required

ID of the room instance as assigned by the server.

Tagsstring[] · max: 128Required

Tags to be set for the room instance.

Responses

200

Tags were set successfully

application/json

404

Room to set tags for was not found

application/json

500

Internal Replication Server error

application/json

post

/tags

HTTPcURLJavaScriptPython

POST /tags HTTP/1.1
Host: 127.0.0.1:64001
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "RoomID": 1,
  "Tags": [
    "text"
  ]
}

{
  "RoomID": 1
}