Monitor and manage game servers for an experience.

Common use cases include:

- Server discovery: [List active game servers](#GameServers_ListGameServers) for a specific place version and [retrieve available filter options](#GameServers_GetFilterOptions)
- Log retrieval: [Inspect logs](#GameServers_ListGameServerLogs) for a specific game server
- Server restarts: [Forecast the impact](#Restarts_ForecastRestart) of a restart, [launch it](#Restarts_LaunchRestart), and [monitor its status](#Restarts_ListRestartStatuses)


Enum describing the different available filter fields.

Describes the metadata and available values for a single filter field.

The list of available values for the filter.

Response model for filter options endpoint.

A dictionary of filter field names to their metadata and available values.

Enum describing the data type of a filter field's values.

Response model for the forecast restart endpoint.

Per-place forecast data keyed by place ID.
Empty if no active places.

Response model for listing a game server log

Optional message context included with structured logging

The Game Server id where the log was created

The full path of the logger that emitted the log entry

Optional message template included with structured logging

The place version on which the log was created

How many more messages were present in the time window beyond our overall rate limits

How many duplicate versions of this message were present in the same time window as this log

A list of ServerManagementService.V2.Models.StructuredStackFrame metadata, identifying the script that errored when combined
with the ServerManagementService.V2.Models.GameServerLog.PlaceVersion

Request model for launching a game restart.

Optional JSON object sent to game servers when the restart is scheduled.
Must be a JSON object and at most 500 bytes when serialized (UTF-8).

Period in minutes before servers begin to be restarted.
During this time, players will not be matchmade to servers scheduled for restart.
Valid range: 1-240.

Optional mapping of place ID to specific PlaceFilter objects.
If empty for a place, restart all versions of that place.
If null/omitted entirely, restart all places in the universe.

Response model for launching a game restart.

Number of game instances that will be closed.

Number of players in instances that will be shut down.

The GameServers from the specified PlaceVersion.

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.

Response model for listing restart statuses.

Defines the various log severity types with values:
Output (0), Info (1), Warning (2), Error (3)

Filter for which versions of a place to restart.

If true, all versions except the most recently published will be restarted.
Mutually exclusive with ServerManagementService.V2.Models.PlaceFilter.Versions.

List of placeVersions to restart. Mutually exclusive with ServerManagementService.V2.Models.PlaceFilter.ExcludeCurrentVersion.

When the place restart ended (null if still in progress).

The filter that was applied to select which versions to restart.

Latest version at the time of the restart.

Initial total count of instances to be restarted.

Initial total count of players to be kicked.

Per-place forecast data for a game restart.

Number of instances that would be closed.

Whether the place does not belong to the universe.
True when a place moved to a different universe but still has active servers from before.

The most recent version of the place in any active server.

Number of players that would be kicked during the restart.

Timestamp for the publication of the latest place version.

Total players currently in the place, including those not impacted.

When the restart was launched (scheduled time).

When the bleed-off period ends and restarts begin.

The maximum number of users in the server.

The current number of users in the server.

The place ID this game server belongs to.

The place version this game server belongs to.

The time the server terminated. Null while ServerManagementService.V2.Models.GameServer.ShutDown is false.

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.

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.

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.

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.

Server status that is visible to creators.
This is derived from the shutdown reason for shutdown rows; it is always "Active" for currently live servers.

Part of the ServerManagementService.V2.Models.GameServerLog and ServerManagementService.V2.Models.ClientLog response objects.
Representing the metadata for a single frame in a structured stack trace.

The name of the function in which the error occurred.

Identifies whether the ServerManagementService.V2.Models.StructuredStackFrame.ScriptUniqueId refers to a script that exists in the Studio Data Model.
If this is true, then the script that generated the error was copied at runtime.
This includes Starter scripts (e.g. StarterGui, StarterPack, StarterPlayerScripts, StarterCharacterScripts).

The line number where the error occurred.

The data model path to the script where the error occurred.

The unique id for the script where the error occurred.
Will be null for frames where the code was from ```loadScript``` or ```require(assetId)```.
If ServerManagementService.V2.Models.StructuredStackFrame.IsDynamic is true, this will be a dynamic id that does not refer to a script in the studio Data Model.

A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.

x-api-key

A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.

.ROBLOSECURITY

Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.

The Roblox API. See https://create.roblox.com/docs/cloud/open-cloud for more details.

Roblox API

universeId

placeId

The specific filter to query. If null or empty, the endpoint returns all available filters.

Filter

Gets available filter options for game servers.

universe:read

versionNumber

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.

MaxPageSize

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.

PageToken

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

OrderBy

This field may be set in order to filter the resources returned.
- CEL filtering is supported on all fields.
- Supported operators &&, <, <=, >, >=, ==, and `in`

Lists game servers for a specific place version.

jobId

The maximum number of log entries to return. Defaults to 25 and values above 100 are
capped at 100.

An opaque token from a previous response. Preserve the other query parameters when
requesting the next page.

Sorts by `message_timestamp` or `log_severity`. Append ` desc` for descending order.
Each endpoint defines its own default when this value is omitted.

Filters log entries with CEL. Use `severity` with equality or `in`, `message_timestamp`
with comparisons, or `search` with equality or inequality for case-insensitive full-text matching.

Lists game server logs for a specific server job id

Launch a game server restart for a universe.

universe:write

Forecast the impact of restarting game servers for a universe.

Observability

Experiences

Avatar

Assets

Samples and projects

Engine API

Open Cloud API

Studio

Analytics

Platform

Tutorials

Creator programs

Education

Learn

This method is asynchronous and returns an `Operation`, which represents the current state of the operation. It contains an endpoint path that you can poll to obtain the real response and applicable metadata. See the [documentation]({longRunningOperationsLink}) on long-running operations for more information.
            
The following sections describe the response and metadata objects that are provided when an operation completes.

Beta endpoints are ready for public use. Breaking changes are possible but rare.

These Open Cloud documentation pages will be removed on March 31, 2026. You will be automatically redirected to the new Open Cloud documentation at that time. {linkStart}Learn more{linkEnd}

These old Open Cloud pages will be removed and redirected on March 31, 2026. {linkStart}Learn more{linkEnd}

Experimental endpoints are ready for public use, but may experience breaking changes occasionally as the API contract is finalized.

This endpoint can be called in-experience through {httpServiceLinkStart}HttpService{httpServiceLinkEnd} with an API key.

This field may be set when creating a resource, but may not be modified by subsequent requests.

These fields may be set when creating a resource, but may not be modified by subsequent requests.

This field may be provided in requests, but will never be included in responses.

Legacy authentication method. Always prefer using API Key or OAuth 2.0 when available.

Per API Key: {maxInPeriod} requests every {periodInSeconds} seconds per IP Address

Requires no authentication to call. Typically has significantly lowered rate limits. Always prefer using API Key or OAuth 2.0 when available.

For each grouping, only one of the following fields in the schema has to be provided, the remaining can be excluded.

You can opt back in at any time. {linkStart}Provide feedback.{linkEnd}

You are viewing the old docs. {linkStart}Provide feedback.{linkEnd}

You can opt out at any time and be redirected back to the old reference pages. {linkStart}Provide feedback.{linkEnd}

You are viewing the revamped docs. {linkStart}Provide feedback.{linkEnd}

This field may be set on responses, but will be ignored in requests.

Note: Rate limits can be lower during high-traffic periods. Certain endpoints have additional rate limits. [Learn more about rate limits]({link}).

{limit} requests per day across all API keys for a user or group

{limit} requests per hour across all API keys for a user or group

{limit} requests per minute across all API keys for a user or group

{limit} requests per second across all API keys for a user or group

{limit} requests per minute per API key owner

{limit} request(s) per second per API key owner

Scopes control what permissions your credentials have. Your credentials can only access the endpoints supported by the scopes you selected.

Stable endpoints are production-ready and will almost never experience breaking changes during their lifetime.

This target enables you to limit your key's access to selected {requiredParts}

This target enables you to limit your key's access to selected {requiredParts} and {optionalParts}

Target types are used to restrict the resources that your credentials have permissions on. Only the selected resources can be acted on even if your account has permissions on additional resources. Some scopes do not have target parts. In these cases, all of your relevant resources can be acted on.

The universe Top Level Part does not need to be selected for user-owned API Keys. In this case, your API Key will have access to all of your user-owned experiences and group-owned experiences that you have the right group permissions on.

Try It Out is not yet supported for endpoints requiring API key or OAuth 2.0 authentication

Cookie authentication is disabled for high risk operations for safety.

Critical risk endpoints are extremely sensitive and Try It Out is disabled for safety

Note: Authentication headers are not included in this code sample. You may need to add an authentication header for this command to work.

This is a high risk endpoint that can modify or delete critical data. Use extreme caution when testing.

This API endpoint has been classified as HIGH RISK and may affect live data or user accounts.

Authenticated requests to high-risk APIs can make changes that cannot be undone. Please review your request parameters carefully before proceeding.

Please login to use cookie authentication

This is a low risk endpoint that retrieves data. This is generally safe to test.

This is a medium risk endpoint that modifies data. Test carefully with non-critical accounts, as changes may be permanent.

To keep your account safe, never paste text here from other sources or send information from this page to others.

You are about to test live API endpoints using your actual account credentials.

Only proceed if you understand the implications of the API calls you're about to make. Review the API documentation carefully before testing.

API calls will be made using your authenticated session

These are real API calls that may affect your account or data

Rate limits and other API restrictions apply

Some operations may modify or delete data

This endpoint has been superseded by these recommended alternative endpoints:

The following scopes are required to call this endpoint. For more
information on generating proper keys, see [Manage API keys]({apiKeyReferenceDocLink}).

For more information on generating keys, see [Manage API keys]({apiKeyReferenceDocLink}).

The following endpoints are available at paths relative to the base URL.

This string is formatted as a [FieldMask](/cloud/reference/types#fieldmask).

A JSON value can be `null`, `boolean`, `string`, `number`, `array`, or `object`.

The following scopes are required for your OAuth 2.0 application to use this endpoint. For more information on how to register an OAuth 2.0 application, see [App registration and review]({oauth2ReferenceDocLink}).

For more information on how to register an OAuth 2.0 application, see [App registration and review]({oauth2ReferenceDocLink}).

The following objects describe payloads that are accepted or returned. See each individual endpoint for more information on when these objects are used.

The following scopes are required to call this endpoint.

Resource Paths

This string is formatted as a [Timestamp](/cloud/reference/types#timestamp).

The following scopes are required for your OAuth 2.0 application to use this endpoint. For more information on how to register an OAuth 2.0 application, see [App Registration and Review]({oauth2ReferenceDocLink}).

Not Recommended

You are viewing the revamped Open Cloud reference.

You've opted out of the new Open Cloud reference.

Grants access to configure billing accounts and purchase ad credit.

View your ad campaigns and their performance.

Create, update, and manage your ad campaigns.

This allows viewing information about your assets.

This allows uploading and updating assets to Roblox.

This allows viewing asset permissions for subjects (including groups and experiences) and assets your account has access to.

This allows granting asset permissions to any subjects (including groups and experiences) and assets your account has access to.

This allows you to view the status and results of avatar auto-setup jobs on your behalf.

This allows you to create and manage avatar auto-setup jobs on your behalf.

Grants the ability to update badges owned by the user.

This allows viewing information about your commerce items.

This allows making changes to your synced commerce items.

This allows viewing information about your commerce merchant connections.

This allows editing of your commerce merchant connections.

This allows you to view information about your Creator Store products.

This allows you to modify information about your Creator Store products.

This allows you to view information about your Creator Store saves.

This allows you to modify information about your Creator Store saves.

Grants access to create data stores on your behalf.

Grants access to delete data stores on your behalf.

Grants access to read a list of data stores.

Grants access to take a snapshot of your data stores.

Grants access to create entries in your data stores.

Grants access to mark specified entries for deletion.

Grants access to list your data store's entries.

Grants access to read specified entries in your data stores.

Grants access to update the value, attributes, and users of an entry.

Grants access to delete revisions of your data store's entries.

Grants access to list revisions for your data store's entries.

Grants access to read revisions of your data store's entries.

Grants access to view configuration details for the authorized user's developer products.

Grants access to edit the authorized user's developer products.

This allows viewing information about your universe's environments.

This allows editing of your universe's environments.

Grants access to view configuration details for the authorized user's game passes.

Grants access to edit the authorized user's game passes.

Grants access to view community forums information for your account.

Grants access to manage community forums information for your account.

This allows viewing information about your communities.

This allows you to manage community join requests and role updates of lower-ranked community members for your account.

Allows you to view an instance's property data.

Allows you to modify the property data of instances (currently only supports Scripts).

This allows viewing information about your inventory.

Grants access to manage your badges and spend Robux.

Grants access to update the authorized user's badges.

Grants access to manage your developer products.

Grants access to read information about the experiences you have notifications on for.

Grants access to turn on or off notifications for experiences on your behalf.

Grants access to manage your communities.

Grants permission to read community information.

Grants access to read and write your localization tables

Grants access to manage team collaboration for all experiences you own.

Grants access to manage your experiences and certain information associated with your experiences (e.g. localization information).

Grants access to read your experiences' localization information.

Grants access to modify your experiences' localization preferences.

Grants access to manage your user account.

Grants access to modify user localization preferences.

Allows you to view the status, logs, and results of Luau execution tasks for the associated place.

Allows you to create new Luau execution tasks for the associated place.

Grants access to asynchronously flush all data structures in the universe.

Grants access to discard read items from the front of the queue.

Grants access to read items at the front of the queue.

Grants access to read your memory store items.

Grants access to create, update, and delete map items.

This grants the ability to publish messages on behalf of users.

This allows sending notifications from your experience to users.

(Deprecated) Grants access to read a list of entries in an ordered data store.

(Deprecated) Grants access to create a new entry in an ordered data store.

Grants access to list entries from an ordered data store.

Grants access to create entries in an ordered data store.

This allows listing secrets associated with your experience.

This allows creating and updating secrets associated with your experience.

This permission allows you to submit an evaluation job and view the job result.

Grants access to read about your subscription products.

This allows you to read thumbnail information on your behalf.

Grants the ability to read analytics alerts.

Grants the ability to create or modify analytics alerts.

Grants the ability to read game analytics.

Grants the ability to write resources related to game analytics.

Grants the ability to read place information.

Grants the ability to edit place information.

Grants access to publish new versions of experiences to Roblox.

This allows you to read thumbnails and thumbnail personalization settings for your experiences.

This allows you to upload and delete thumbnails and manage thumbnail personalization settings for your experiences.

Grants the ability to read experience information.

Grants access to edit the authorized user's experiences.

Allows you to view user restrictions in the experience.

Allows you to edit user restrictions in the experience.

This allows viewing notifications sent to your account.

Grants the ability to read the authorized user's premium and verified status.

This allows you to view the authorized user's social accounts.

Grants the ability to read a game's events.

This enables Single Sign-On functionality.

This grants access to read your profile information.