ROroblox
Observability

Lists game servers for a specific place version.

Changed on
get/server-management/v1/universes/{universeId}/places/{placeId}/versions/{versionNumber}/game-servers

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/server-management/v1/universes/{universeId}/places/{placeId}/versions/{versionNumber}/game-servers
  • Auth
    • API key in cookie .ROBLOSECURITY
    • or API key in header x-api-key
    • or OAuth 2
      Authorization code: https://apis.roblox.com/oauth/v1/authorize
      Token URL: https://apis.roblox.com/oauth/v1/token scopes: universe:read

Path parameters

universeIdinteger required

The universe ID

placeIdinteger required

The place ID

versionNumberstring required

The version number

Query parameters

MaxPageSizeinteger

The maximum number of game servers to return. The service might return fewer than this value. If unspecified, at most 25 game servers are returned. The maximum value is 100 and higher values are set to 100. Zero returns no game servers and only the total count, for callers that need the count without paging through rows.

PageTokenstring

A page token, received from a previous call, to retrieve a subsequent page. When paginating, all other parameters provided to the subsequent call must match the call that provided the page token.

OrderBystring

Sorting is supported only for a single field at a time. Example: "orderBy": "uptime" Defaults to ascending, but descending ordering is also supported by including the " desc" suffix. For example: "orderBy": "uptime desc".

Filterstring

This field may be set in order to filter the resources returned.

  • CEL filtering is supported on all fields.
  • Supported operators &&, <, <=, >, >=, ==, and in

Response

Success

nextPageTokenstring nullable

A token that you can send as a pageToken parameter to retrieve the next page. If this field is omitted, there are no subsequent pages.

previousPageTokenstring nullable

A 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.

totalCountinteger nullable

Total 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.

shutdownServersFetchErrorboolean nullable

True 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.

activeServersFetchErrorboolean nullable

True 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.

Example response

{
  "gameServers": [
    {
      "uptime": "1.02:03:04"
    }
  ]
}

Changes