3 min read

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

ServerManagementService.GameServer — openapi

Response model for listing a Game Server

Properties

Related Schemas

• ServerType

• ServerStatus

Complete Schema

{
  "type": "object",
  "properties": {
    "placeId": {
      "type": "string",
      "description": "The place ID this game server belongs to.",
      "nullable": true
    },
    "placeVersion": {
      "type": "string",
      "description": "The place version this game server belongs to.",
      "nullable": true
    },
    "jobId": {
      "type": "string",
      "description": "The unique ID for this server.",
      "nullable": true
    },
    "engineVersion": {
      "type": "string",
      "description": "The RCC Version the server is running",
      "nullable": true
    },
    "createTime": {
      "type": "string",
      "description": "The time this server was created.",
      "format": "date-time"
    },
    "uptime": {
      "type": "string",
      "description": "How long this server has been running.",
      "format": "date-span",
      "example": "1.02:03:04"
    },
    "memoryUsageBytes": {
      "type": "integer",
      "description": "The Memory Usage of the server in bytes.",
      "format": "int64"
    },
    "frameRate": {
      "type": "number",
      "description": "The Server Frame Rate.",
      "format": "float",
      "nullable": true
    },
    "occupancy": {
      "type": "integer",
      "description": "The current number of users in the server.",
      "format": "int32"
    },
    "maxOccupancy": {
      "type": "integer",
      "description": "The maximum number of users in the server.",
      "format": "int32"
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ServerType"
        }
      ],
      "description": "The Type of Server."
    },
    "full": {
      "type": "boolean",
      "description": "Whether the server is at max occupancy."
    },
    "shutDown": {
      "type": "boolean",
      "description": "Whether the server has been shutdown."
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ServerStatus"
        }
      ],
      "description": "Creator-visible server status."
    },
    "terminationTime": {
      "type": "string",
      "description": "The time the server terminated. Null while ServerManagementService.V2.Models.GameServer.ShutDown is false.",
      "format": "date-time",
      "nullable": true
    },
    "playerIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int64"
      },
      "description": "The list of PlayerIds in the server",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "Response model for listing a Game Server"
}