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.

LaunchUpdateResponse — openapi

Launch Update response.

Properties

NameTypeRequiredDescription
updateIdstringfalseAn ID for UI to query status of this update
numPlayersToBeKickedintegerfalseHow many players are playing in servers that will be shut down according to the update configuration
instancesToBeClosedintegerfalseHow many game instances will be closed according to the update configuration

Complete Schema

{
  "type": "object",
  "properties": {
    "updateId": {
      "type": "string",
      "description": "An ID for UI to query status of this update",
      "format": "uuid"
    },
    "numPlayersToBeKicked": {
      "type": "integer",
      "description": "How many players are playing in servers that will be shut down according to the update configuration",
      "format": "int32"
    },
    "instancesToBeClosed": {
      "type": "integer",
      "description": "How many game instances will be closed according to the update configuration",
      "format": "int32"
    }
  },
  "additionalProperties": false,
  "description": "Launch Update response."
}