Matchmaking - Start Game

Instructs the PlayFab game server hosting service to instantiate a new Game Server Instance

POST https://titleId.playfabapi.com/Matchmaker/StartGame

Request Header

Name Required Type Description
X-SecretKey True
  • string

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name Required Type Description
Build True
  • string

Unique identifier of the previously uploaded build executable which is to be started.

ExternalMatchmakerEventEndpoint True
  • string

HTTP endpoint URL for receiving game status events, if using an external matchmaker. When the game ends, PlayFab will make a POST request to this URL with the X-SecretKey header set to the value of the game's secret and an application/json body of { "EventName": "game_ended", "GameID": "" }.

GameMode True
  • string

Game mode for this Game Server Instance.

Region True

Region with which to associate the server, for filtering.

CustomCommandLineData
  • string

Custom command line argument when starting game server process.

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-SecretKey

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Type: apiKey
In: header

Definitions

ApiErrorWrapper

The basic wrapper around every failed API response

Region
StartGameRequest
StartGameResponse

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

Region

Name Type Description
Australia
  • string
Brazil
  • string
EUWest
  • string
Japan
  • string
Singapore
  • string
USCentral
  • string
USEast
  • string

StartGameRequest

Name Type Description
Build
  • string

Unique identifier of the previously uploaded build executable which is to be started.

CustomCommandLineData
  • string

Custom command line argument when starting game server process.

CustomTags
  • object

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

ExternalMatchmakerEventEndpoint
  • string

HTTP endpoint URL for receiving game status events, if using an external matchmaker. When the game ends, PlayFab will make a POST request to this URL with the X-SecretKey header set to the value of the game's secret and an application/json body of { "EventName": "game_ended", "GameID": "" }.

GameMode
  • string

Game mode for this Game Server Instance.

Region

Region with which to associate the server, for filtering.

StartGameResponse

Name Type Description
GameID
  • string

Unique identifier for the game/lobby in the new Game Server Instance.

ServerIPV4Address
  • string

IPV4 address of the server

ServerIPV6Address
  • string

IPV6 address of the new Game Server Instance.

ServerPort
  • number

Port number for communication with the Game Server Instance.

ServerPublicDNSName
  • string

Public DNS name (if any) of the server

Error Codes

Name Code
BuildNotFound 1032