RestartUniverseServersRequest — openapi

Restarts all of the universe's servers.

Properties

Name	Type	Required	Description
placeIds	array	false	The place IDs to update. If none are specified, all active places in the universe will be updated.
closeAllVersions	boolean	false	If true, players from servers running both old and new place versions will be restarted. If false, restarts all active servers for a specific universe if and only if a new version of the experience has been published.
bleedOffServers	boolean	false	If true, matchmaking to servers will stop, but servers will stay up for bleed_off_duration_minutes before shutting down. This setting gives players time to naturally migrate to the newer version. If false, servers will immediately start shutting down.
bleedOffDurationMinutes	integer	false	If bleed_off_servers is true, how long (in minutes) old servers are allowed to stay up before shutting them down. Valid values: 1-60 minutes.

Complete Schema

{
  "type": "object",
  "properties": {
    "placeIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int64"
      },
      "description": "The place IDs to update. If none are specified, all active places in the\nuniverse will be updated."
    },
    "closeAllVersions": {
      "example": true,
      "type": "boolean",
      "description": "If true, players from servers running both old and new place versions will\nbe restarted. If false, restarts all active servers for a specific universe\nif and only if a new version of the experience has been published."
    },
    "bleedOffServers": {
      "example": true,
      "type": "boolean",
      "description": "If true, matchmaking to servers will stop, but servers will stay up for\nbleed_off_duration_minutes before shutting down.\nThis setting gives players time to naturally migrate to the newer version.\nIf false, servers will immediately start shutting down."
    },
    "bleedOffDurationMinutes": {
      "example": 10,
      "type": "integer",
      "description": "If bleed_off_servers is true, how long (in minutes) old servers are allowed\nto stay up before shutting them down. Valid values: 1-60 minutes.",
      "format": "int32"
    }
  },
  "description": "Restarts all of the universe's servers."
}