메인 콘텐츠로 건너뛰기
POST
Join Lobby As Server

인증

X-EntityToken
string
header
필수

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

본문

application/json

Preview: Request to join a lobby as a server. Only callable by a game_server entity and this is restricted to client owned lobbies which are using connections.

Preview: Request to join a lobby as a server. Only callable by a game_server entity and this is restricted to client owned lobbies which are using connections.

ConnectionString
string
필수

A field which indicates which lobby the game_server will be joining. This field is opaque to everyone except the Lobby service.

ServerEntity
object
필수

The game_server entity which is joining the Lobby. If a different game_server entity has already joined the request will fail unless the joined entity is disconnected, in which case the incoming game_server entity will replace the disconnected entity.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

ServerData
object

The private key-value pairs which are visible to all entities in the lobby but can only be modified by the joined server.At most 30 key - value pairs may be stored here, keys are limited to 30 characters and values to 1000.The total size of all serverData values may not exceed 4096 bytes.

응답

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
마지막 수정일 2026년 10월 6일