Skip to main content

instances/:worldid

Gets a list of public instances a world is hosting

Path Parameters
worldid string — REQUIRED

The WorldId to get instances of

Responses
200

A successful request

Schema — OPTIONAL
success boolean

Was the operation a success

message string

The message returned by the server

result object — OPTIONAL

The result of the server response

Meta object — OPTIONAL

The WorldMeta

SafeInstances array — OPTIONAL

An array of SafeInstance meta

GameServerId string — OPTIONAL

The GameServerId the instance is running on

InstanceId string — OPTIONAL

The Id of the instance

InstanceCreatorId string — OPTIONAL

The UserId of the user who created the instance

InstancePublicity integer — OPTIONAL

The publicity of the instance

InstanceProtocol string — OPTIONAL

The networking protocol of the instance

ConnectedUsers array — OPTIONAL

An array of UserIds that are connected to an instance

WorldId string — OPTIONAL

The WorldId that the instance is hosting