LaunchUpdateRequest — openapi

Launch Update Request. Contains specification for how update should roll out

Properties

Name	Type	Required	Description
universeId	integer	false	The Universe ID to update.
placeIds	array	false	The place IDs to update. If none are specified, we will update all active Places in the Universe
closeOldVersionsOnly	boolean	false	If true (default in UI), we will only migrate players from servers running old PlaceVersions. If false, we will migrate all players
bleedOffServers	boolean	false	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
bleedOffDurationMinutes	integer	false	If BleedOffServers=true, how long will we allow old servers to stay up before shutting them down. Valid values: 1 - 60 minutes
placeIdToVersions	object	false	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.
attributes	string	false	Optional. Attributes string to include in the ServerLifecycleChanged CSM payload published to game servers.

Complete Schema

{
  "type": "object",
  "properties": {
    "universeId": {
      "type": "integer",
      "description": "The Universe ID to update.",
      "format": "int64"
    },
    "placeIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int64"
      },
      "description": "The place IDs to update. If none are specified, we will update all active Places in the Universe",
      "nullable": true
    },
    "closeOldVersionsOnly": {
      "type": "boolean",
      "description": "If true (default in UI), we will only migrate players from servers running old PlaceVersions.\r\nIf false, we will migrate all players"
    },
    "bleedOffServers": {
      "type": "boolean",
      "description": "If true (default in UI), we will stop matchmaking to servers but keep them up before shutting them down, allowing\r\n players to naturally migrate to the newer version.\r\nIf false, we will immediately start shutting down servers"
    },
    "bleedOffDurationMinutes": {
      "type": "integer",
      "description": "If BleedOffServers=true, how long will we allow old servers to stay up before shutting them down.\r\nValid values: 1 - 60 minutes",
      "format": "int32"
    },
    "placeIdToVersions": {
      "type": "object",
      "additionalProperties": {
        "uniqueItems": true,
        "type": "array",
        "items": {
          "type": "integer",
          "format": "int32"
        },
        "nullable": true
      },
      "description": "Optional. A mapping of PlaceId to the specific versions to restart/bleed off for that place.\r\nWhen set for a place, only servers running those exact versions will be affected.\r\nIf a place is not in this dictionary or has an empty set, behavior falls back to CloseOldVersionsOnly logic.",
      "nullable": true
    },
    "attributes": {
      "type": "string",
      "description": "Optional. Attributes string to include in the ServerLifecycleChanged CSM payload published to game servers.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "Launch Update Request. Contains specification for how update should roll out"
}