> ## Documentation Index > Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt > Use this file to discover all available pages before exploring further. # Create Build With Managed Container > Creates a multiplayer server build with a managed container. Allowed entity token types: title ## Error codes This operation may return the following PlayFab errors: | Error | Code | | --- | --- | | APINotEnabledForGameClientAccess | 1082 | | MultiplayerServerBadRequest | 1382 | | MultiplayerServerConflict | 1386 | | MultiplayerServerForbidden | 1384 | | MultiplayerServerInternalServerError | 1387 | | MultiplayerServerTitleQuotaCoresExceeded | 1445 | | MultiplayerServerUnauthorized | 1383 | | MultiplayerServerUnavailable | 1388 | | ProductDisabledForTitle | 1609 | ## OpenAPI ````yaml post /MultiplayerServer/CreateBuildWithManagedContainer openapi: 3.0.0 info: version: '260922' title: PlayFab Multiplayer API description: >- API methods for managing multiplayer servers. API methods for managing parties. The lobby service helps players group together to play multiplayer games. It is often used as a rendezvous point for players to share connection information. The TrueSkill service helps titles to estimate a player's skill based on their match results. The player skill values from this service are commonly used by a matchmaking service to provide players with balanced matches. termsOfService: https://playfab.com/terms/ contact: url: https://community.playfab.com/index.html license: name: Apache 2.0 url: https://github.com/PlayFab/API_Specs/blob/master/LICENSE servers: - url: https://{titleId}.playfabapi.com description: PlayFab title endpoint variables: titleId: default: your_title_id description: Your PlayFab title ID (hex). security: [] tags: - name: Lobby description: '' - name: Matchmaking description: Matchmaking APIs - name: Matchmaking Admin description: Matchmaking Admin APIs - name: MultiplayerServer description: Multiplayer Server APIs - name: PubSub description: PlayFab PubSub APIs - name: TrueSkill description: TrueSkill APIs - name: TrueSkill Admin description: TrueSkill Admin APIs paths: /MultiplayerServer/CreateBuildWithManagedContainer: post: tags: - MultiplayerServer summary: Create Build With Managed Container description: | Creates a multiplayer server build with a managed container. Allowed entity token types: title ## Error codes This operation may return the following PlayFab errors: | Error | Code | | --- | --- | | APINotEnabledForGameClientAccess | 1082 | | MultiplayerServerBadRequest | 1382 | | MultiplayerServerConflict | 1386 | | MultiplayerServerForbidden | 1384 | | MultiplayerServerInternalServerError | 1387 | | MultiplayerServerTitleQuotaCoresExceeded | 1445 | | MultiplayerServerUnauthorized | 1383 | | MultiplayerServerUnavailable | 1388 | | ProductDisabledForTitle | 1609 | operationId: CreateBuildWithManagedContainer requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBuildWithManagedContainerRequest' description: >- Creates a multiplayer server build with a managed container and returns information about the build creation request. responses: '200': $ref: '#/components/responses/CreateBuildWithManagedContainerResponse' '400': $ref: '#/components/responses/ApiErrorWrapper' security: - EntityToken: [] components: schemas: CreateBuildWithManagedContainerRequest: description: >- Creates a multiplayer server build with a managed container and returns information about the build creation request. type: object properties: AreAssetsReadonly: description: >- When true, assets will not be copied for each server inside the VM. All serverswill run from the same set of assets, or will have the same assets mounted in the container. type: boolean BuildName: description: The build name. type: string ContainerFlavor: allOf: - $ref: '#/components/schemas/ContainerFlavor' description: The flavor of container to create a build from. CustomTags: description: >- The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). type: object GameAssetReferences: description: The list of game assets related to the build. type: array items: $ref: '#/components/schemas/AssetReferenceParams' x-isclass: true GameCertificateReferences: description: The game certificates for the build. type: array items: $ref: '#/components/schemas/GameCertificateReferenceParams' x-isclass: true GameSecretReferences: description: The game secrets for the build. type: array items: $ref: '#/components/schemas/GameSecretReferenceParams' x-isclass: true GameWorkingDirectory: description: >- The directory containing the game executable. This would be the start path of the game assets that contain the main game server executable. If not provided, a best effort will be made to extract it from the start game command. type: string InstrumentationConfiguration: allOf: - $ref: '#/components/schemas/InstrumentationConfiguration' description: The instrumentation configuration for the build. Metadata: description: >- Metadata to tag the build. The keys are case insensitive. The build metadata is made available to the server through Game Server SDK (GSDK).Constraints: Maximum number of keys: 30, Maximum key length: 50, Maximum value length: 100 type: object MultiplayerServerCountPerVm: description: The number of multiplayer servers to host on a single VM. type: number x-actualtype: int32 Ports: description: The ports to map the build on. type: array items: $ref: '#/components/schemas/Port' x-isclass: true RegionConfigurations: description: The region configurations for the build. type: array items: $ref: '#/components/schemas/BuildRegionParams' x-isclass: true ServerResourceConstraints: allOf: - $ref: '#/components/schemas/ServerResourceConstraintParams' description: >- The resource constraints to apply to each server on the VM (EXPERIMENTAL API) StartMultiplayerServerCommand: description: >- The command to run when the multiplayer server is started, including any arguments. type: string VmSize: allOf: - $ref: '#/components/schemas/AzureVmSize' description: The VM size to create the build on. VmStartupScriptConfiguration: allOf: - $ref: '#/components/schemas/VmStartupScriptParams' description: The configuration for the VmStartupScript for the build WindowsCrashDumpConfiguration: allOf: - $ref: '#/components/schemas/WindowsCrashDumpConfiguration' description: The crash dump configuration for the build. required: - StartMultiplayerServerCommand - GameAssetReferences - BuildName - MultiplayerServerCountPerVm - Ports - RegionConfigurations example: StartMultiplayerServerCommand: gameserver.exe -startserver GameAssetReferences: - FileName: gameserver.zip MountPath: C:\Asset\ InstrumentationConfiguration: ProcessesToMonitor: - GameServerProcessName IsEnabled: true GameWorkingDirectory: C:\Assets ServerResourceConstraints: CpuLimit: 0.5 MemoryLimitGB: 0.5 BuildName: GameBuildName Metadata: MetadataKey: MetadataValue VmSize: Standard_D2_v2 MultiplayerServerCountPerVm: 10 Ports: - Name: PortName Num: 1243 RegionConfigurations: - Region: EastUs MaxServers: 10 StandbyServers: 5 ScheduledStandbySettings: IsEnabled: true ScheduleList: - StartTime: '2020-08-21T17:00:00Z' EndTime: '2020-08-24T09:00:00Z' IsRecurringWeekly: true Description: Weekend Schedule TargetStandby: 8 - StartTime: '2020-08-24T09:00:00Z' EndTime: '2020-08-28T17:00:00Z' IsRecurringWeekly: true Description: Weekday Schedule TargetStandby: 3 - Region: WestUs MaxServers: 50 StandbyServers: 8 ScheduledStandbySettings: IsEnabled: true ScheduleList: - StartTime: '2020-08-21T09:00:00Z' EndTime: '2020-08-21T23:00:00Z' Description: Game Launch TargetStandby: 30 - Region: NorthEurope MaxServers: 7 StandbyServers: 3 GameCertificateReferences: - Name: CertName GsdkAlias: CertGsdkAlias GameSecretReferences: - Name: SecretName ContainerFlavor: type: string enum: - ManagedWindowsServerCore - CustomLinux - ManagedWindowsServerCorePreview - Invalid AssetReferenceParams: type: object properties: FileName: description: The asset's file name. type: string MountPath: description: The asset's mount path. type: string required: - FileName GameCertificateReferenceParams: type: object properties: GsdkAlias: description: >- 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. type: string Name: description: >- The name of the game certificate. This name should match the name of a certificate that was previously uploaded to this title. type: string required: - Name - GsdkAlias GameSecretReferenceParams: type: object properties: Name: description: >- The name of the game secret. This name should match the name of a secret that was previously added to this title. type: string required: - Name InstrumentationConfiguration: type: object properties: IsEnabled: description: >- Designates whether windows instrumentation configuration will be enabled for this Build type: boolean ProcessesToMonitor: description: >- This property is deprecated, use IsEnabled. The list of processes to be monitored on a VM for this build. Providing processes will turn on performance metrics collection for this build. Process names should not include extensions. If the game server process is: GameServer.exe; then, ProcessesToMonitor = [ GameServer ] type: array items: type: string Port: type: object properties: Name: description: The name for the port. type: string Num: description: The number for the port. type: number x-actualtype: int32 Protocol: allOf: - $ref: '#/components/schemas/ProtocolType' description: The protocol for the port. required: - Name - Num - Protocol BuildRegionParams: type: object properties: DynamicStandbySettings: allOf: - $ref: '#/components/schemas/DynamicStandbySettings' description: >- Optional settings to control dynamic adjustment of standby target. If not specified, dynamic standby is disabled MaxServers: description: The maximum number of multiplayer servers for the region. type: number x-actualtype: int32 MultiplayerServerCountPerVm: description: >- Regional override for the number of multiplayer servers to host on a single VM of the build. type: number x-actualtype: int32 Region: allOf: - $ref: '#/components/schemas/AzureRegion' description: The build region. ScheduledStandbySettings: allOf: - $ref: '#/components/schemas/ScheduledStandbySettings' description: >- Optional settings to set the standby target to specified values during the supplied schedules StandbyServers: description: The number of standby multiplayer servers for the region. type: number x-actualtype: int32 VmSize: allOf: - $ref: '#/components/schemas/AzureVmSize' description: Regional override for the VM size the build was created on. required: - Region - MaxServers - StandbyServers ServerResourceConstraintParams: type: object properties: CpuLimit: description: The maximum number of cores that each server is allowed to use. type: number x-actualtype: double MemoryLimitGB: description: >- The maximum number of GiB of memory that each server is allowed to use. WARNING: After exceeding this limit, the server will be killed type: number x-actualtype: double required: - CpuLimit - MemoryLimitGB AzureVmSize: type: string enum: - Standard_A1 - Standard_A2 - Standard_A3 - Standard_A4 - Standard_A1_v2 - Standard_A2_v2 - Standard_A4_v2 - Standard_A8_v2 - Standard_D1_v2 - Standard_D2_v2 - Standard_D3_v2 - Standard_D4_v2 - Standard_D5_v2 - Standard_D2_v3 - Standard_D4_v3 - Standard_D8_v3 - Standard_D16_v3 - Standard_F1 - Standard_F2 - Standard_F4 - Standard_F8 - Standard_F16 - Standard_F2s_v2 - Standard_F4s_v2 - Standard_F8s_v2 - Standard_F16s_v2 - Standard_F2as_v6 - Standard_F4as_v6 - Standard_F8as_v6 - Standard_F16as_v6 - Standard_F2as_v7 - Standard_F4as_v7 - Standard_F8as_v7 - Standard_F16as_v7 - Standard_F2ads_v7 - Standard_F4ads_v7 - Standard_F8ads_v7 - Standard_F16ads_v7 - Standard_D2as_v4 - Standard_D4as_v4 - Standard_D8as_v4 - Standard_D16as_v4 - Standard_D2a_v4 - Standard_D4a_v4 - Standard_D8a_v4 - Standard_D16a_v4 - Standard_D2ads_v5 - Standard_D4ads_v5 - Standard_D8ads_v5 - Standard_D16ads_v5 - Standard_D2ads_v6 - Standard_D4ads_v6 - Standard_D8ads_v6 - Standard_D16ads_v6 - Standard_D2ads_v7 - Standard_D4ads_v7 - Standard_D8ads_v7 - Standard_D16ads_v7 - Standard_E2a_v4 - Standard_E4a_v4 - Standard_E8a_v4 - Standard_E16a_v4 - Standard_E2as_v4 - Standard_E4as_v4 - Standard_E8as_v4 - Standard_E16as_v4 - Standard_E2ads_v5 - Standard_E4ads_v5 - Standard_E8ads_v5 - Standard_E16ads_v5 - Standard_E2ads_v6 - Standard_E4ads_v6 - Standard_E8ads_v6 - Standard_E16ads_v6 - Standard_E2ads_v7 - Standard_E4ads_v7 - Standard_E8ads_v7 - Standard_E16ads_v7 - Standard_E2ds_v4 - Standard_E4ds_v4 - Standard_E8ds_v4 - Standard_E16ds_v4 - Standard_E2ds_v5 - Standard_E4ds_v5 - Standard_E8ds_v5 - Standard_E16ds_v5 - Standard_E2ds_v6 - Standard_E4ds_v6 - Standard_E8ds_v6 - Standard_E16ds_v6 - Standard_D2s_v3 - Standard_D4s_v3 - Standard_D8s_v3 - Standard_D16s_v3 - Standard_DS1_v2 - Standard_DS2_v2 - Standard_DS3_v2 - Standard_DS4_v2 - Standard_DS5_v2 - Standard_NC4as_T4_v3 - Standard_D2d_v4 - Standard_D4d_v4 - Standard_D8d_v4 - Standard_D16d_v4 - Standard_D2ds_v4 - Standard_D4ds_v4 - Standard_D8ds_v4 - Standard_D16ds_v4 - Standard_HB120_16rs_v3 - Standard_HB120_32rs_v3 - Standard_HB120_64rs_v3 - Standard_HB120_96rs_v3 - Standard_HB120rs_v3 - Standard_D2d_v5 - Standard_D4d_v5 - Standard_D8d_v5 - Standard_D16d_v5 - Standard_D32d_v5 - Standard_D2ds_v5 - Standard_D4ds_v5 - Standard_D8ds_v5 - Standard_D16ds_v5 - Standard_D32ds_v5 - Standard_D2ds_v6 - Standard_D4ds_v6 - Standard_D8ds_v6 - Standard_D16ds_v6 - Standard_D2pds_v6 - Standard_D4pds_v6 - Standard_D8pds_v6 - Standard_D16pds_v6 VmStartupScriptParams: type: object properties: PortRequests: description: >- Optional port requests (name/protocol) that will be used by the VmStartupScript. Max of 5 requests. type: array items: $ref: '#/components/schemas/VmStartupScriptPortRequestParams' x-isclass: true VmStartupScriptAssetReference: allOf: - $ref: '#/components/schemas/AssetReferenceParams' description: >- Asset which contains the VmStartupScript script and any other required files. required: - VmStartupScriptAssetReference WindowsCrashDumpConfiguration: type: object properties: CustomDumpFlags: description: >- See https://learn.microsoft.com/en-us/windows/win32/wer/collecting-user-mode-dumps for valid values. type: number x-actualtype: int32 DumpType: description: >- See https://learn.microsoft.com/en-us/windows/win32/wer/collecting-user-mode-dumps for valid values. type: number x-actualtype: int32 IsEnabled: description: >- Designates whether automatic crash dump capturing will be enabled for this Build. type: boolean required: - IsEnabled CreateBuildWithManagedContainerResponse: type: object properties: AreAssetsReadonly: description: >- When true, assets will not be copied for each server inside the VM. All serverswill run from the same set of assets, or will have the same assets mounted in the container. type: boolean BuildId: description: The guid string build ID. Must be unique for every build. type: string BuildName: description: The build name. type: string ContainerFlavor: allOf: - $ref: '#/components/schemas/ContainerFlavor' description: The flavor of container of the build. CreationTime: description: The time the build was created in UTC. type: string GameAssetReferences: description: The game assets for the build. type: array items: $ref: '#/components/schemas/AssetReference' x-isclass: true GameCertificateReferences: description: The game certificates for the build. type: array items: $ref: '#/components/schemas/GameCertificateReference' x-isclass: true GameSecretReferences: description: The game secrets for the build. type: array items: $ref: '#/components/schemas/GameSecretReference' x-isclass: true GameWorkingDirectory: description: >- The directory containing the game executable. This would be the start path of the game assets that contain the main game server executable. If not provided, a best effort will be made to extract it from the start game command. type: string InstrumentationConfiguration: allOf: - $ref: '#/components/schemas/InstrumentationConfiguration' description: The instrumentation configuration for this build. Metadata: description: The metadata of the build. type: object MultiplayerServerCountPerVm: description: >- The number of multiplayer servers to host on a single VM of the build. type: number x-actualtype: int32 OsPlatform: allOf: - $ref: '#/components/schemas/OsPlatform' description: The OS platform used for running the game process. Ports: description: The ports the build is mapped on. type: array items: $ref: '#/components/schemas/Port' x-isclass: true RegionConfigurations: description: The region configuration for the build. type: array items: $ref: '#/components/schemas/BuildRegion' x-isclass: true ServerResourceConstraints: allOf: - $ref: '#/components/schemas/ServerResourceConstraintParams' description: >- The resource constraints to apply to each server on the VM (EXPERIMENTAL API) ServerType: allOf: - $ref: '#/components/schemas/ServerType' description: The type of game server being hosted. StartMultiplayerServerCommand: description: >- The command to run when the multiplayer server has been allocated, including any arguments. type: string VmSize: allOf: - $ref: '#/components/schemas/AzureVmSize' description: The VM size the build was created on. VmStartupScriptConfiguration: allOf: - $ref: '#/components/schemas/VmStartupScriptConfiguration' description: The configuration for the VmStartupScript feature for the build required: - MultiplayerServerCountPerVm example: StartMultiplayerServerCommand: gameserver.exe -startserver InstrumentationConfiguration: ProcessesToMonitor: - GameServerProcessName IsEnabled: true GameWorkingDirectory: C:\Assets BuildId: 21781fa8-096d-4d9c-b699-75433d579285 BuildName: GameBuildName CreationTime: '2014-04-07T09:04:28' Metadata: MetadataKey: MetadataValue VmSize: Standard_D2_v2 Ports: - Name: PortName Num: 1243 RegionConfigurations: - Region: EastUs Status: Initializing MaxServers: 10 StandbyServers: 5 ScheduledStandbySettings: IsEnabled: true ScheduleList: - StartTime: '2020-08-21T17:00:00Z' EndTime: '2020-08-24T09:00:00Z' IsRecurringWeekly: true Description: Weekend Schedule TargetStandby: 8 - StartTime: '2020-08-24T09:00:00Z' EndTime: '2020-08-28T17:00:00Z' IsRecurringWeekly: true Description: Weekday Schedule TargetStandby: 3 - Region: WestUs Status: Succeeded MaxServers: 50 StandbyServers: 8 ScheduledStandbySettings: IsEnabled: true ScheduleList: - StartTime: '2020-08-21T09:00:00Z' EndTime: '2020-08-21T23:00:00Z' Description: Game Launch TargetStandby: 30 - Region: NorthEurope Status: Unhealthy MaxServers: 7 StandbyServers: 3 GameAssetReferences: - FileName: gameserver.zip MountPath: C:\Asset\ GameCertificateReferences: - Name: CertName GsdkAlias: CertGsdkAlias GameSecretReferences: - Name: SecretName MultiplayerServerCountPerVm: 10 ApiErrorWrapper: description: The basic wrapper around every failed API response type: object properties: code: description: Numerical HTTP code type: integer status: description: String HTTP code type: string error: description: Playfab error code type: string errorCode: description: Numerical PlayFab error code type: integer errorMessage: description: Description for the PlayFab errorCode type: string errorDetails: description: Detailed description of individual issues with the request object type: object required: - code - errorCode ProtocolType: type: string enum: - TCP - UDP DynamicStandbySettings: type: object properties: DynamicFloorMultiplierThresholds: description: >- List of auto standing by trigger values and corresponding standing by multiplier. Defaults to 1.5X at 50%, 3X at 25%, and 4X at 5% type: array items: $ref: '#/components/schemas/DynamicStandbyThreshold' x-isclass: true IsEnabled: description: When true, dynamic standby will be enabled type: boolean RampDownSeconds: description: >- The time it takes to reduce target standing by to configured floor value after an increase. Defaults to 30 minutes type: number x-actualtype: int32 required: - IsEnabled AzureRegion: type: string enum: - AustraliaEast - AustraliaSoutheast - BrazilSouth - CentralUs - EastAsia - EastUs - EastUs2 - JapanEast - JapanWest - NorthCentralUs - NorthEurope - SouthCentralUs - SoutheastAsia - WestEurope - WestUs - SouthAfricaNorth - WestCentralUs - KoreaCentral - FranceCentral - WestUs2 - CentralIndia - UaeNorth - UkSouth - SwedenCentral - CanadaCentral - MexicoCentral - WestUs3 - CanadaEast - UkWest - FranceSouth - SouthIndia - SpainCentral - GermanyWestCentral - ItalyNorth - IndonesiaCentral - ChileCentral - PolandCentral - NewZealandNorth - BrazilSoutheast - NorwayEast - SwitzerlandNorth - MalaysiaWest - IsraelCentral - QatarCentral - UaeCentral - GermanyNorth - AustriaEast - BelgiumCentral - DenmarkEast - SwitzerlandWest - SwedenSouth - NorwayWest - SouthAfricaWest - MalaysiaSouth ScheduledStandbySettings: type: object properties: IsEnabled: description: When true, scheduled standby will be enabled type: boolean ScheduleList: description: A list of non-overlapping schedules type: array items: $ref: '#/components/schemas/Schedule' x-isclass: true required: - IsEnabled VmStartupScriptPortRequestParams: type: object properties: Name: description: The name for the port. type: string Protocol: allOf: - $ref: '#/components/schemas/ProtocolType' description: The protocol for the port. required: - Name - Protocol AssetReference: type: object properties: FileName: description: >- The asset's file name. This is a filename with the .zip, .tar, or .tar.gz extension. type: string MountPath: description: The asset's mount path. type: string GameCertificateReference: type: object properties: GsdkAlias: description: >- 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. type: string Name: description: >- The name of the game certificate. This name should match the name of a certificate that was previously uploaded to this title. type: string GameSecretReference: type: object properties: Name: description: >- The name of the game secret. This name should match the name of a secret that was previously added to this title. type: string OsPlatform: type: string enum: - Windows - Linux BuildRegion: type: object properties: CurrentServerStats: allOf: - $ref: '#/components/schemas/CurrentServerStats' description: The current multiplayer server stats for the region. DynamicStandbySettings: allOf: - $ref: '#/components/schemas/DynamicStandbySettings' description: Optional settings to control dynamic adjustment of standby target IsAssetReplicationComplete: description: >- Whether the game assets provided for the build have been replicated to this region. type: boolean MaxServers: description: The maximum number of multiplayer servers for the region. type: number x-actualtype: int32 MultiplayerServerCountPerVm: description: >- Regional override for the number of multiplayer servers to host on a single VM of the build. type: number x-actualtype: int32 Region: allOf: - $ref: '#/components/schemas/AzureRegion' description: The build region. ScheduledStandbySettings: allOf: - $ref: '#/components/schemas/ScheduledStandbySettings' description: >- Optional settings to set the standby target to specified values during the supplied schedules StandbyServers: description: The target number of standby multiplayer servers for the region. type: number x-actualtype: int32 Status: description: >- The status of multiplayer servers in the build region. Valid values are - Unknown, Initialized, Deploying, Deployed, Unhealthy, Deleting, Deleted. type: string VmSize: allOf: - $ref: '#/components/schemas/AzureVmSize' description: Regional override for the VM size the build was created on. required: - MaxServers - StandbyServers - IsAssetReplicationComplete ServerType: type: string enum: - Container - Process VmStartupScriptConfiguration: type: object properties: PortRequests: description: >- Optional port requests (name/protocol) that will be used by the VmStartupScript. Max of 5 requests. type: array items: $ref: '#/components/schemas/VmStartupScriptPortRequest' x-isclass: true VmStartupScriptAssetReference: allOf: - $ref: '#/components/schemas/AssetReference' description: >- Asset which contains the VmStartupScript script and any other required files. required: - VmStartupScriptAssetReference DynamicStandbyThreshold: type: object properties: Multiplier: description: When the trigger threshold is reached, multiply by this value type: number x-actualtype: double TriggerThresholdPercentage: description: >- The multiplier will be applied when the actual standby divided by target standby floor is less than this value type: number x-actualtype: double required: - TriggerThresholdPercentage - Multiplier Schedule: type: object properties: Description: description: >- A short description about this schedule. For example, "Game launch on July 15th". type: string EndTime: description: >- The date and time in UTC at which the schedule ends. If IsRecurringWeekly is true, this schedule will keep renewing for future weeks until disabled or removed. type: string IsDisabled: description: Disables the schedule. type: boolean IsRecurringWeekly: description: If true, the StartTime and EndTime will get renewed every week. type: boolean StartTime: description: The date and time in UTC at which the schedule starts. type: string TargetStandby: description: The standby target to maintain for the duration of the schedule. type: number x-actualtype: int32 required: - StartTime - EndTime - IsRecurringWeekly - IsDisabled - TargetStandby CurrentServerStats: type: object properties: Active: description: The number of active multiplayer servers. type: number x-actualtype: int32 Propping: description: >- The number of multiplayer servers still downloading game resources (such as assets). type: number x-actualtype: int32 StandingBy: description: The number of standingby multiplayer servers. type: number x-actualtype: int32 Total: description: The total number of multiplayer servers. type: number x-actualtype: int32 required: - Active - StandingBy - Propping - Total VmStartupScriptPortRequest: type: object properties: Name: description: The name for the port. type: string Protocol: allOf: - $ref: '#/components/schemas/ProtocolType' description: The protocol for the port. required: - Name - Protocol responses: CreateBuildWithManagedContainerResponse: description: '' content: application/json: schema: type: object properties: code: type: integer description: >- The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code. status: type: string description: The Http status code as a string. data: $ref: '#/components/schemas/CreateBuildWithManagedContainerResponse' example: code: 200 status: OK data: StartMultiplayerServerCommand: gameserver.exe -startserver InstrumentationConfiguration: ProcessesToMonitor: - GameServerProcessName IsEnabled: true GameWorkingDirectory: C:\Assets BuildId: 21781fa8-096d-4d9c-b699-75433d579285 BuildName: GameBuildName CreationTime: '2014-04-07T09:04:28' Metadata: MetadataKey: MetadataValue VmSize: Standard_D2_v2 Ports: - Name: PortName Num: 1243 RegionConfigurations: - Region: EastUs Status: Initializing MaxServers: 10 StandbyServers: 5 ScheduledStandbySettings: IsEnabled: true ScheduleList: - StartTime: '2020-08-21T17:00:00Z' EndTime: '2020-08-24T09:00:00Z' IsRecurringWeekly: true Description: Weekend Schedule TargetStandby: 8 - StartTime: '2020-08-24T09:00:00Z' EndTime: '2020-08-28T17:00:00Z' IsRecurringWeekly: true Description: Weekday Schedule TargetStandby: 3 - Region: WestUs Status: Succeeded MaxServers: 50 StandbyServers: 8 ScheduledStandbySettings: IsEnabled: true ScheduleList: - StartTime: '2020-08-21T09:00:00Z' EndTime: '2020-08-21T23:00:00Z' Description: Game Launch TargetStandby: 30 - Region: NorthEurope Status: Unhealthy MaxServers: 7 StandbyServers: 3 GameAssetReferences: - FileName: gameserver.zip MountPath: C:\Asset\ GameCertificateReferences: - Name: CertName GsdkAlias: CertGsdkAlias GameSecretReferences: - Name: SecretName MultiplayerServerCountPerVm: 10 ApiErrorWrapper: description: This is the outer wrapper for all responses with errors content: application/json: schema: $ref: '#/components/schemas/ApiErrorWrapper' securitySchemes: EntityToken: type: apiKey in: header name: X-EntityToken description: >- This API requires an Entity Session Token, available from the Entity GetEntityToken method. ```` ## Related topics - [Create Build With Managed Container](/services/playfab/api-references/rest/multiplayer/multiplayerserver/create-build-with-managed-container.md) - [Basics of a PlayFab game server](/services/playfab/multiplayer/servers/basics-of-a-playfab-game-server.md) - [Automatic crash dump collection](/services/playfab/multiplayer/servers/crash-dump-collection.md) - [VM metrics](/services/playfab/multiplayer/servers/vm-metrics.md) - [Scaling Programmatically](/services/playfab/multiplayer/servers/scaling-programmatically.md)