Multiplayer Server - List Qos Servers For Title

  • Reference
Service:
Multiplayer
API Version:
220425

Lists quality of service servers for the title. By default, servers are only returned for regions where a Multiplayer Servers build has been deployed.

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

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 Type Description
CustomTags
  • object

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

Indicates that the response should contain Qos servers for all regions, including those where there are no builds deployed for the title.

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
AzureRegion
ListQosServersForTitleRequest

Returns a list of quality of service servers for a title.
ListQosServersForTitleResponse
QosServer

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

AzureRegion

Name Type Description
AustraliaEast
  • string
AustraliaSoutheast
  • string
BrazilSouth
  • string
CentralIndia
  • string
CentralUs
  • string
EastAsia
  • string
EastUs
  • string
EastUs2
  • string
FranceCentral
  • string
JapanEast
  • string
JapanWest
  • string
KoreaCentral
  • string
NorthCentralUs
  • string
NorthEurope
  • string
SouthAfricaNorth
  • string
SouthCentralUs
  • string
SoutheastAsia
  • string
UaeNorth
  • string
UkSouth
  • string
WestCentralUs
  • string
WestEurope
  • string
WestUs
  • string
WestUs2
  • string

ListQosServersForTitleRequest

Returns a list of quality of service servers for a title.

Name Type Description
CustomTags
  • object

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

Indicates that the response should contain Qos servers for all regions, including those where there are no builds deployed for the title.

ListQosServersForTitleResponse

Name Type Description
PageSize
  • number

The page size on the response.
QosServers

The list of QoS servers.
SkipToken
  • string

The skip token for the paged response.

QosServer

Name Type Description
Region

The region the QoS server is located in.
ServerUrl
  • string

The QoS server URL.

Error Codes

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