Away 12:07 AM

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.

ServerManagementService.ListGameServersResponse — openapi

Response model for listing game servers.

Properties

NameTypeRequiredDescription
gameServersarrayfalseThe GameServers from the specified PlaceVersion.
nextPageTokenstringfalseA token that you can send as a pageToken parameter to retrieve the next page. If this field is omitted, there are no subsequent pages.
previousPageTokenstringfalseA token that you can send as a pageToken parameter to retrieve the previous page (reverse cursor). If this field is omitted, there are no prior pages.
totalCountintegerfalseTotal matching rows across all pages. Combined active+shutdown queries return the sum of each source total when both are known; omitted when a source failed or omitted its total.
shutdownServersFetchErrorbooleanfalseTrue when this page includes active rows but shutdown rows could not be fetched. Results may be a partial slice of the globally ordered combined stream.
activeServersFetchErrorbooleanfalseTrue when this page includes shutdown rows but active rows could not be fetched. Results may be a partial slice of the globally ordered combined stream.

Complete Schema

{
  "type": "object",
  "properties": {
    "gameServers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ServerManagementService.GameServer"
      },
      "description": "The GameServers from the specified PlaceVersion.",
      "nullable": true
    },
    "nextPageToken": {
      "type": "string",
      "description": "A token that you can send as a `pageToken` parameter to retrieve the next\r\npage. If this field is omitted, there are no subsequent pages.",
      "nullable": true
    },
    "previousPageToken": {
      "type": "string",
      "description": "A token that you can send as a `pageToken` parameter to retrieve the previous\r\npage (reverse cursor). If this field is omitted, there are no prior pages.",
      "nullable": true
    },
    "totalCount": {
      "type": "integer",
      "description": "Total matching rows across all pages. Combined active+shutdown queries return the sum of\r\neach source total when both are known; omitted when a source failed or omitted its total.",
      "format": "int32",
      "nullable": true
    },
    "shutdownServersFetchError": {
      "type": "boolean",
      "description": "True when this page includes active rows but shutdown rows could not be fetched.\r\nResults may be a partial slice of the globally ordered combined stream.",
      "nullable": true
    },
    "activeServersFetchError": {
      "type": "boolean",
      "description": "True when this page includes shutdown rows but active rows could not be fetched.\r\nResults may be a partial slice of the globally ordered combined stream.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "Response model for listing game servers."
}