Multiplayer Server - Create Build With Custom Container

Creates a multiplayer server build with a custom container.

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

Request Body

Name Required Type Description
BuildName True
  • string

The build name.

ContainerFlavor

The flavor of container to create a build from.

ContainerImageReference

The container reference, consisting of the image name and tag.

ContainerRepositoryName
  • string

The name of the container repository.

ContainerRunCommand
  • string

The container command to run when the multiplayer server has been allocated, including any arguments.

ContainerTag
  • string

The tag for the container.

GameAssetReferences

The list of game assets related to the build.

GameCertificateReferences

The game certificates for the build.

Metadata
  • object

Metadata to tag the build. The keys are case insensitive. The build metadata is made available to the server through Game Server SDK (GSDK).

MultiplayerServerCountPerVm True
  • number

The number of multiplayer servers to host on a single VM.

Ports True

The ports to map the build on.

RegionConfigurations True

The region configurations for the build.

VmSize

The VM size to create the build on.

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer-wrapper for all responses with errors

Security

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

AssetReference
AssetReferenceParams
AzureRegion
AzureVmSize
BuildRegion
BuildRegionParams
ContainerFlavor
ContainerImageReference
CreateBuildWithCustomContainerRequest

Creates a multiplayer server build with a custom container and returns information about the build creation request.

CreateBuildWithCustomContainerResponse
CurrentServerStats
GameCertificateReference
GameCertificateReferenceParams
Port
ProtocolType

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code
  • number

Numerical HTTP code

error
  • string

Playfab error code

errorCode
  • number

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

AssetReference

Name Type Description
FileName
  • string

The asset's file name. This is a filename with the .zip, .tar, or .tar.gz extension.

MountPath
  • string

The asset's mount path.

AssetReferenceParams

Name Type Description
FileName
  • string

The asset's file name.

MountPath
  • string

The asset's mount path.

AzureRegion

Name Type Description
AustraliaEast
  • string
AustraliaSoutheast
  • string
BrazilSouth
  • string
CentralUs
  • string
ChinaEast2
  • string
ChinaNorth2
  • string
EastAsia
  • string
EastUs
  • string
EastUs2
  • string
JapanEast
  • string
JapanWest
  • string
NorthCentralUs
  • string
NorthEurope
  • string
SouthAfricaNorth
  • string
SouthCentralUs
  • string
SoutheastAsia
  • string
WestEurope
  • string
WestUs
  • string

AzureVmSize

Name Type Description
Standard_A1
  • string
Standard_A1_v2
  • string
Standard_A2
  • string
Standard_A2_v2
  • string
Standard_A3
  • string
Standard_A4
  • string
Standard_A4_v2
  • string
Standard_A8_v2
  • string
Standard_D1_v2
  • string
Standard_D2_v2
  • string
Standard_D3_v2
  • string
Standard_D4_v2
  • string
Standard_D5_v2
  • string
Standard_F1
  • string
Standard_F16
  • string
Standard_F16s_v2
  • string
Standard_F2
  • string
Standard_F2s_v2
  • string
Standard_F4
  • string
Standard_F4s_v2
  • string
Standard_F8
  • string
Standard_F8s_v2
  • string

BuildRegion

Name Type Description
CurrentServerStats

The current multiplayer server stats for the region.

MaxServers
  • number

The maximum number of multiplayer servers for the region.

Region

The build region.

StandbyServers
  • number

The number of standby multiplayer servers for the region.

Status
  • string

The status of multiplayer servers in the build region. Valid values are - Unknown, Initialized, Deploying, Deployed, Unhealthy.

BuildRegionParams

Name Type Description
MaxServers
  • number

The maximum number of multiplayer servers for the region.

Region

The build region.

StandbyServers
  • number

The number of standby multiplayer servers for the region.

ContainerFlavor

Name Type Description
CustomLinux
  • string
ManagedWindowsServerCore
  • string
ManagedWindowsServerCorePreview
  • string

ContainerImageReference

Name Type Description
ImageName
  • string

The container image name.

Tag
  • string

The container tag.

CreateBuildWithCustomContainerRequest

Creates a multiplayer server build with a custom container and returns information about the build creation request.

Name Type Description
BuildName
  • string

The build name.

ContainerFlavor

The flavor of container to create a build from.

ContainerImageReference

The container reference, consisting of the image name and tag.

ContainerRepositoryName
  • string

The name of the container repository.

ContainerRunCommand
  • string

The container command to run when the multiplayer server has been allocated, including any arguments.

ContainerTag
  • string

The tag for the container.

GameAssetReferences

The list of game assets related to the build.

GameCertificateReferences

The game certificates for the build.

Metadata
  • object

Metadata to tag the build. The keys are case insensitive. The build metadata is made available to the server through Game Server SDK (GSDK).

MultiplayerServerCountPerVm
  • number

The number of multiplayer servers to host on a single VM.

Ports

The ports to map the build on.

RegionConfigurations

The region configurations for the build.

VmSize

The VM size to create the build on.

CreateBuildWithCustomContainerResponse

Name Type Description
BuildId
  • string

The guid string build ID. Must be unique for every build.

BuildName
  • string

The build name.

ContainerFlavor

The flavor of container of the build.

ContainerRunCommand
  • string

The container command to run when the multiplayer server has been allocated, including any arguments.

CreationTime
  • string

The time the build was created in UTC.

CustomGameContainerImage

The custom game container image reference information.

GameAssetReferences

The game assets for the build.

GameCertificateReferences

The game certificates for the build.

Metadata
  • object

The metadata of the build.

MultiplayerServerCountPerVm
  • number

The number of multiplayer servers to host on a single VM of the build.

Ports

The ports the build is mapped on.

RegionConfigurations

The region configuration for the build.

VmSize

The VM size the build was created on.

CurrentServerStats

Name Type Description
Active
  • number

The number of active multiplayer servers.

Propping
  • number

The number of multiplayer servers still downloading game resources (such as assets).

StandingBy
  • number

The number of standingby multiplayer servers.

Total
  • number

The total number of multiplayer servers.

GameCertificateReference

Name Type Description
GsdkAlias
  • string

An alias for the game certificate. The game server will reference this alias via GSDK config to retrieve the game certificate. This alias is used as an identifier in game server code to allow a new certificate with different Name field to be uploaded without the need to change any game server code to reference the new Name.

Name
  • string

The name of the game certificate. This name should match the name of a certificate that was previously uploaded to this title.

GameCertificateReferenceParams

Name Type Description
GsdkAlias
  • string

An alias for the game certificate. The game server will reference this alias via GSDK config to retrieve the game certificate. This alias is used as an identifier in game server code to allow a new certificate with different Name field to be uploaded without the need to change any game server code to reference the new Name.

Name
  • string

The name of the game certificate. This name should match the name of a certificate that was previously uploaded to this title.

Port

Name Type Description
Name
  • string

The name for the port.

Num
  • number

The number for the port.

Protocol

The protocol for the port.

ProtocolType

Name Type Description
TCP
  • string
UDP
  • string

Error Codes

Name Code
MultiplayerServerBadRequest 1382
MultiplayerServerConflict 1386
MultiplayerServerForbidden 1384
MultiplayerServerInternalServerError 1387
MultiplayerServerUnauthorized 1383