Multiplayer Server - Get Multiplayer Server Logs

Gets multiplayer server logs after a server has terminated.

POST https://titleId.playfabapi.com/MultiplayerServer/GetMultiplayerServerLogs

Request Header

Name Required Type Description
X-EntityToken True
  • string

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

Request Body

Name Required Type Description
ServerId True
  • string

The server ID of multiplayer server to get logs for.

CustomTags
  • object

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

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer wrapper for all responses with errors

Security

X-EntityToken

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

Type: apiKey
In: header

Definitions

ApiErrorWrapper

The basic wrapper around every failed API response

GetMultiplayerServerLogsRequest

Gets multiplayer server logs for a specific server id in a region. The logs are available only after a server has terminated.

GetMultiplayerServerLogsResponse

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code
  • integer

Numerical HTTP code

error
  • string

Playfab error code

errorCode
  • integer

Numerical PlayFab error code

errorDetails
  • object

Detailed description of individual issues with the request object

errorMessage
  • string

Description for the PlayFab errorCode

status
  • string

String HTTP code

GetMultiplayerServerLogsRequest

Gets multiplayer server logs for a specific server id in a region. The logs are available only after a server has terminated.

Name Type Description
CustomTags
  • object

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

ServerId
  • string

The server ID of multiplayer server to get logs for.

GetMultiplayerServerLogsResponse

Name Type Description
LogDownloadUrl
  • string

URL for logs download.

Error Codes

Name Code
APINotEnabledForGameClientAccess 1082
MultiplayerServerBadRequest 1382
MultiplayerServerForbidden 1384
MultiplayerServerInternalServerError 1387
MultiplayerServerNotFound 1385
MultiplayerServerTooManyRequests 1380
MultiplayerServerUnauthorized 1383
MultiplayerServerUnavailable 1388