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

GameServers object — OPTIONAL

An array of GameServers that are public

SafeInstances array — OPTIONAL

An array of SafeInstance meta

GameServerId string — OPTIONAL

The GameServerId the instance is running on

Region object — OPTIONAL

The Id of the instance

ContinentCode string

The abbreviation for a continent

City string — OPTIONAL

The city the GameServer resides in

State string — OPTIONAL

The state the GameServer resides in

Country string — OPTIONAL

The country the GameServer resides in

Latitude integer — OPTIONAL

The Latitude of the GameServer

Longitude integer — OPTIONAL

The Longitude of the GameServer