v1

latestOpenAPI 3.0.42026-08-068161,1253.1 MB

Matchmaking

Launch a game update

post/matchmaking-api/v1/game-instances/launch-update

Request body

universeIdinteger

The Universe ID to update.

placeIdsinteger[] nullable

The place IDs to update. If none are specified, we will update all active Places in the Universe

closeOldVersionsOnlyboolean

If true (default in UI), we will only migrate players from servers running old PlaceVersions. If false, we will migrate all players

bleedOffServersboolean

If true (default in UI), we will stop matchmaking to servers but keep them up before shutting them down, allowing players to naturally migrate to the newer version. If false, we will immediately start shutting down servers

bleedOffDurationMinutesinteger

If BleedOffServers=true, how long will we allow old servers to stay up before shutting them down. Valid values: 1 - 60 minutes

placeIdToVersionsobject nullable

Optional. A mapping of PlaceId to the specific versions to restart/bleed off for that place. When set for a place, only servers running those exact versions will be affected. If a place is not in this dictionary or has an empty set, behavior falls back to CloseOldVersionsOnly logic.

attributesstring nullable

Optional. Attributes string to include in the ServerLifecycleChanged CSM payload published to game servers.

Response

Success

updateIdstring uuid

An ID for UI to query status of this update

numPlayersToBeKickedinteger

How many players are playing in servers that will be shut down according to the update configuration

instancesToBeClosedinteger

How many game instances will be closed according to the update configuration