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.

PrivateServersApi.GameServerResponse — openapi

Properties

NameTypeRequiredDescription
idstringfalse
maxPlayersintegerfalse
playingintegerfalse
playerTokensarrayfalse
playersarrayfalse
fpsnumberfalse
pingintegerfalse
namestringfalse
vipServerIdintegerfalse
accessCodestringfalse
ownerfalse

Complete Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "nullable": true
    },
    "maxPlayers": {
      "type": "integer",
      "format": "int32"
    },
    "playing": {
      "type": "integer",
      "format": "int32"
    },
    "playerTokens": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "players": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PrivateServerPlayerResponse"
      },
      "nullable": true
    },
    "fps": {
      "type": "number",
      "format": "double"
    },
    "ping": {
      "type": "integer",
      "format": "int32"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "vipServerId": {
      "type": "integer",
      "format": "int64",
      "nullable": true
    },
    "accessCode": {
      "type": "string",
      "format": "uuid",
      "nullable": true
    },
    "owner": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VerifiedBadgeUserResponse"
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}