1 min read

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

LaunchRestartResponse — openapi

Response model for launching a game restart.

Properties

NameTypeRequiredDescription
idstringfalseID of the restart.
playersImpactedintegerfalseNumber of players in instances that will be shut down.
instancesImpactedintegerfalseNumber of game instances that will be closed.

Complete Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the restart.",
      "nullable": true
    },
    "playersImpacted": {
      "type": "integer",
      "description": "Number of players in instances that will be shut down.",
      "format": "int32"
    },
    "instancesImpacted": {
      "type": "integer",
      "description": "Number of game instances that will be closed.",
      "format": "int32"
    }
  },
  "additionalProperties": false,
  "description": "Response model for launching a game restart."
}