Matchmaking - Register Game

Inform the matchmaker that a new Game Server Instance is added.

POST https://titleId.playfabapi.com/Server/RegisterGame

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 build running on the Game Server Instance.

GameMode True
  • string

Game Mode the Game Server instance is running. Note that this must be defined in the Game Modes tab in the PlayFab Game Manager, along with the Build ID (the same Game Mode can be defined for multiple Build IDs).

Region True

Region in which the Game Server Instance is running. For matchmaking using non-AWS region names, set this to any AWS region and use Tags (below) to specify your custom region.

ServerPort True
  • string

Port number for communication with the Game Server Instance.

CustomTags
  • object

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

LobbyId
  • string

Previous lobby id if re-registering an existing game.

ServerIPV4Address
  • string

IPV4 address of the game server instance.

ServerIPV6Address
  • string

IPV6 address (if any) of the game server instance.

ServerPublicDNSName
  • string

Public DNS name (if any) of the server

Tags
  • object

Tags for the Game Server Instance

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
RegisterGameRequest
RegisterGameResponse

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

RegisterGameRequest

Name Type Description
Build
  • string

Unique identifier of the build running on the Game Server Instance.

CustomTags
  • object

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

GameMode
  • string

Game Mode the Game Server instance is running. Note that this must be defined in the Game Modes tab in the PlayFab Game Manager, along with the Build ID (the same Game Mode can be defined for multiple Build IDs).

LobbyId
  • string

Previous lobby id if re-registering an existing game.

Region

Region in which the Game Server Instance is running. For matchmaking using non-AWS region names, set this to any AWS region and use Tags (below) to specify your custom region.

ServerIPV4Address
  • string

IPV4 address of the game server instance.

ServerIPV6Address
  • string

IPV6 address (if any) of the game server instance.

ServerPort
  • string

Port number for communication with the Game Server Instance.

ServerPublicDNSName
  • string

Public DNS name (if any) of the server

Tags
  • object

Tags for the Game Server Instance

RegisterGameResponse

Name Type Description
LobbyId
  • string

Unique identifier generated for the Game Server Instance that is registered. If LobbyId is specified in request and the game still exists in PlayFab, the LobbyId in request is returned. Otherwise a new lobby id will be returned.