2 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

PlaceRestartStatus — openapi

Per-place restart status.

Properties

NameTypeRequiredDescription
statefalseCurrent state of the place restart.
startTimestringfalseWhen the place restart started.
endTimestringfalseWhen the place restart ended (null if still in progress).
totalPlayersintegerfalseInitial total count of players to be kicked.
totalInstancesintegerfalseInitial total count of instances to be restarted.
remainingPlayersintegerfalseRemaining players to be kicked.
remainingInstancesintegerfalseRemaining instances to be closed.
filterfalseThe filter that was applied to select which versions to restart.
latestVersionstringfalseLatest version at the time of the restart.

Complete Schema

{
  "type": "object",
  "properties": {
    "state": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RestartState"
        }
      ],
      "description": "Current state of the place restart."
    },
    "startTime": {
      "type": "string",
      "description": "When the place restart started.",
      "format": "date-time"
    },
    "endTime": {
      "type": "string",
      "description": "When the place restart ended (null if still in progress).",
      "format": "date-time",
      "nullable": true
    },
    "totalPlayers": {
      "type": "integer",
      "description": "Initial total count of players to be kicked.",
      "format": "int32"
    },
    "totalInstances": {
      "type": "integer",
      "description": "Initial total count of instances to be restarted.",
      "format": "int32"
    },
    "remainingPlayers": {
      "type": "integer",
      "description": "Remaining players to be kicked.",
      "format": "int32"
    },
    "remainingInstances": {
      "type": "integer",
      "description": "Remaining instances to be closed.",
      "format": "int32"
    },
    "filter": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PlaceFilter"
        }
      ],
      "description": "The filter that was applied to select which versions to restart.",
      "nullable": true
    },
    "latestVersion": {
      "type": "string",
      "description": "Latest version at the time of the restart.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "Per-place restart status."
}