Documentation

GetMatchmakerGameInfo

Retrieves the details for a specific completed session, including links to standard out and standard error logs

Request Details

GetMatchmakerGameInfoRequest
Request Properties
LobbyId (required) String

unique identifier of the lobby for which info is being requested

POST https://{{TitleID}}.playfabapi.com/Admin/GetMatchmakerGameInfo
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "LobbyId": "2938488"
}
        

Response Details

GetMatchmakerGameInfoResult
Result Properties
BuildVersion String

version identifier of the game server executable binary being run

EndTime DateTime

time when Game Server Instance is currently scheduled to end

LobbyId String

unique identifier of the lobby

Mode String

game mode for this Game Server Instance

Players List<String>

array of unique PlayFab identifiers for users currently connected to this Game Server Instance

Region Region

region in which the Game Server Instance is running

ServerIPV4Address String

IPV4 address of the server

ServerIPV6Address String

IPV6 address of the server

ServerPort (required) uint32

communication port for this Game Server Instance

ServerPublicDNSName String

Public DNS name (if any) of the server

StartTime (required) DateTime

time when the Game Server Instance was created

TitleId String

unique identifier of the Game Server Instance for this lobby

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "LobbyId": "2938488",
    "TitleId": "2084",
    "StartTime": "2016-04-20T10:32:58Z",
    "EndTime": "2016-04-20T21:08:14Z",
    "Mode": "0",
    "BuildVersion": "5.0.1",
    "Region": "USCentral",
    "ServerAddress": "10.250.24.54",
    "ServerPort": 1243
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code
GameNotFound 1024