Optional bool to confirm intention to purchase multiple private servers in quick succession.

A response model representing a game server player.

true for favor the game, false for unfavor the game.

Response model for getting the game creator

The game creator account is Luobu Real Name Verified

Response model for getting the game detail

Gets or sets the flag to indicate whether the create vip servers button should be allowed in game details page

The game genre from experience-genres-service

The game subgenre from experience-genres-service

The game description in the source language, if different from the returned description.

The game name in the source language, if different from the returned name.

The setting of IsStudioAccessToApisAllowed of the universe

Avatar type. Possible values are MorphToR6, MorphToR15, and PlayerChoice ['MorphToR6' = 1, 'PlayerChoice' = 2, 'MorphToR15' = 3]

Response model for getting the game media item

The media item type, Image or YouTubeVideo

Response model for getting the game product information

The game seller id
User ID for users, Agent ID for groups

Provide all necessary information which helps analytics for improvement, for example, the algorithm, dataset version, position, etc..

The id of the owner of the private server

The name of the owner of the private server

The price of the private server product in robux

Response model for getting private servers

The cursor to use for the next page of data.

The cursor to use for the previous page of data.

Response model for getting a universe's playability status for a user

Whether or not the universe is playable for the user

The actual playability status of the universe including the reason if unplayable ['UnplayableOtherReason' = 0, 'Playable' = 1, 'GuestProhibited' = 2, 'GameUnapproved' = 3, 'IncorrectConfiguration' = 4, 'UniverseRootPlaceIsPrivate' = 5, 'InsufficientPermissionFriendsOnly' = 6, 'InsufficientPermissionGroupOnly' = 7, 'DeviceRestricted' = 8, 'UnderReview' = 9, 'PurchaseRequired' = 10, 'AccountRestricted' = 11, 'TemporarilyUnavailable' = 12, 'PlaceHasNoPublishedVersion' = 13, 'ComplianceBlocked' = 14, 'ContextualPlayabilityRegionalAvailability' = 15, 'ContextualPlayabilityRegionalCompliance' = 16, 'ContextualPlayabilityAgeRecommendationParentalControls' = 17, 'ContextualPlayabilityExperienceBlockedParentalControls' = 18, 'ContextualPlayabilityAgeGated' = 19, 'ContextualPlayabilityUnverifiedSeventeenPlusUser' = 20, 'FiatPurchaseRequired' = 21, 'FiatPurchaseDeviceRestricted' = 22, 'ContextualPlayabilityUnrated' = 23, 'ContextualPlayabilityAgeGatedByDescriptor' = 24, 'ContextualPlayabilityGeneral' = 25]

The universeId of the requested universe to help with batching requests

Localized display text explaining why unplayable

Response model for getting whether a universe has private servers enabled.

Whether private servers are enabled in the universe.

ID of base price, needed by clients to prepare purchase url.

Fiat purchase price in a localized string for display on client.

Zendesk (or similar forum provider) article ID for the client to build a redirect URL.

The base URL that the client should redirect to.

The display text with a placeholder for clients to inject a link, such as:
  "Learn more about policy xyz {linkStart}Learn More{linkEnd}"

Response model for getting the user vote status for a game

A response model specific to multi-get user.

Response model for VIP server can-invite user.

Invite response type ['Invalid' = 0, 'CanInvite' = 1, 'UnableToAddAnyUser' = 2, 'UnableToAddNonFriends' = 3, 'UnableToAddSpecificUser' = 4]

Response model for VIP server permissions.

Response model for VIP server subscription.

Subscription cancelled due to insufficient funds

Request model for updating permissions for a VIP server.

Request model to update subscriptions for a VIP server.

The current frames per second the server is running at.

The max number of players allowed to enter the server at the same time.

The game server ping time (measured in milliseconds).

The thumbnail tokens for all the players in the server.

The number of players actively in the server.

Games Api v1

A list of universe Ids. Cannot exceed a maximum of 100 IDs.

universeIds

8: No universe IDs were specified.
9: Too many universe IDs were requested.

Gets a list of games' product info, used to purchase a game

List of placeId to uniquely Identify a place

placeIds

0: Authorization has been denied for this request.

Gets a list of universe playability statuses for the authenticated user

universeId

requestBody

15: The price for purchasing this private server has changed. Please refresh the page and try again.

16: We are having a problem completing your purchase. Please try again in a few minutes.

3: The asset is not voteable.
8: No universe IDs were specified.
9: Too many universe IDs were requested.

10: Internal service busy. Please try again later.

The Id of the place we are geting the private server list for.

placeId

limit

The paging cursor for the previous or next page.

cursor

sortOrder

1: The place is invalid.
7: Guest users are not allowed.

Get list of private servers user can access for given game id.

The Id of the place we are geting the server list for.

The type of the server we geting the server list for.

serverType

excludeFullGames

1: The place is invalid.
6: The server type is invalid. For fetching private servers, please use https://games.roblox.com/v1/games/{placeId}/private-servers.
7: Guest users are not allowed.

2: The requested universe does not exist.

Returns if a game was marked as favorite for the authenticated user

request

0: Token Validation Failed
11: You are not authorized to perform this action.

Favors (or unfavors) a game for the authenticated user

Get the favorites count of a specific game.

The cursor to figure out where to start fetching

1: The requested universe does not exist.

The id of the universe we get media data from.

2: The universe's root place is invalid.
3: The asset is not voteable.
4: The requested vote is invalid.

0: Token Validation Failed
6: The user needs to play the game before vote.
7: The user needs additional permission to vote.

5: Too many attempts to vote. Please try again later.
10: Internal service busy. Please try again later.

The id of the universe we get vote status from.

2: The universe's root place is invalid.
3: The asset is not voteable.

The id of the universe we get user vote status from.

privateServerIds

8: The creator of this game has disabled private servers for this game.
34: Invalid request, private server ids cannot be null.
35: Guest users are not allowed.

2: You are not the owner of this private server.

1: The private server is invalid or does not exist.
4: The universe does not exist.

Get private servers from private server ids

Checks if the private servers are enabled in the specified universe.

privateServersTab

itemsPerPage

39: Invalid cursor provided in the request.

Get private servers for the authenticated user

userId

Determines if a user by id is allowed to receive a VIP Server invite from the authenticated user.

8: The creator of this game has disabled private servers for this game.

The Roblox.Games.Api.VipServerUpdateRequest

8: The creator of this game has disabled private servers for this game.
10: The name of the private server is either empty or too long.

0: Token Validation Failed
2: You are not the owner of this private server.
11: You cannot activate a cancelled private server.
12: The game must not be Friends Only to allow private servers.
13: Join Link can be generated only for active private servers.

3: Please wait a few minutes before configuring your private server again.

The Roblox.Games.Api.VipServerUpdatePermissionsRequest

6: You cannot add so many players to the private server's invite list.
8: The creator of this game has disabled private servers for this game.
12: The game must not be Friends Only to allow private servers.
28: You may only add or remove valid players to your private server's invite list.
29: You may only add or remove players when your private server is active.

0: Token Validation Failed
2: You are not the owner of this private server.

Update friend/clan access and allowed friends/clan list

The Roblox.Games.Api.VipServerUpdateSubscriptionRequest

8: The creator of this game has disabled private servers for this game.
32: You do not have enough funds available to renew the subscription for this private server.

0: Token Validation Failed
2: You are not the owner of this private server.
21: You may not configure a cancelled private server. Please renew your subscription before configuring.

Updates subscription status of a vip server

The Roblox.Games.Api.VipServerUpdateVoiceSettingsRequest

0: Token Validation Failed
2: You are not the owner of this private server.
33: You are not eligible for voice chat.

1: The private server is invalid or does not exist.

Update voice settings for a private server.

Overview

Experiences

Avatar

Assets

Open Cloud

Create

Discovery

Localization

Analytics

Design

Scale

Affiliates

Monetize

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.

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.

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

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

The following API key permissions are required to call this endpoint. For more
information on generating proper 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}).

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

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}).

This allows viewing information about your assets.

This allows uploading and updating assets to Roblox.

Grants the ability to update badges owned by the user.

This allows viewing information about your commerce items.

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 viewing information about your communities.

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

This allows viewing information about your inventory.

Grants access to mange your badges and spend robux.

Grants access to manage your developer products.

Grants access to read information about the experiences you follow.

Grants access to follow and unfollow 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.

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

This allows sending notifications from your experience to users.

This allows listing secrets associated with your experience.

This allows creating and updating secrets associated with your experience.

Grants access to read about your subscription products.

Grants the ability to read place information.

Grants the ability to edit place information.

This operation grants access to publish new versions of experiences to Roblox.

Grants the ability to read experience information.

Grants the ability to edit experience information.

Allows you to view user restrictions in the experience.

Allows you to edit user restrictions in the experience.

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

This allows you to view a user's social accounts.

This enables Single Sign-On functionality.

This grants access to read your profile information.

Default Value: {defaultValueStart}{defaultValueEnd}

An array is an ordered list of values. Arrays are useful for storing collections of data.

A set of key-value pairs, where the keys can be any number, string, or object.

This function returns immediately if possible, but can yield the thread that called it until it can return a value.

{nameStart}name{nameEnd} is no longer supported or maintained by Roblox.

This math operation is no longer supported or maintained by Roblox.

This member doesn’t appear in the object browser and is not intended for widespread use.

This member is only accessible only through the command bar. Attempting to access this member from scripts causes an error.

This function can’t pause the Lua thread that called it.

Attempting to access this member in scripts causes an error. You might be able to access this member from Roblox Studio's property window.

This member doesn’t appear in Roblox Studio’s Object Browser.

You can’t create an instance of this class with the Instance.new constructor.

Roblox does not replicate this member across its server-client boundary.

Lua code can’t access this member. You might be able to change its value from the property window in Roblox Studio.

This member is accessible from OpenCloud Luau execution tasks.

This object’s replication behavior is dependent on the player who owns it.

This member is accessible through the command bar and plugins. Attempting to access this member from scripts causes an error.

This member is read only. Attempting to write to this member causes an error.

This property is read-only and is safe to read in unsynchronized threads. Attempting to write to it causes an error.

This member is accessible only in CoreScripts.

Only Roblox CoreScripts can access this member, and it isn’t usable by Players.

You can read and write to this property safely from multiple threads.

This class is a top-level singleton. Retrieve an instance of this class with the GetService function.

Multiple threads can potentially write to this property, so it’s unsafe to read from unsynchronized threads.

This function pauses the Lua thread that called it until it returns a result. This doesn’t interrupt other scripts.

Games v1