path

query

List Data Stores

Takes a new snapshot of the data stores in an experience.

 After a snapshot, the next write to every key in the experience will
 create a versioned backup of the previous data, regardless of the time of
 the last write.

 In effect, all data current at the time of the snapshot is guaranteed to be
 available as a versioned backup for at least 30 days.

 Snapshots can be taken once per UTC day, per experience. If the latest
 snapshot was taken within the same UTC day, this operation is a no-op and
 the time of the latest snapshot will be returned.

 For more information on using snapshots, see the [Data
 Stores](https://create.roblox.com/docs/cloud-services/data-stores#snapshots)
 Engine guide.

Snapshot Data Stores

DataStore

AcceptGroupJoinRequestRequest

Represents a product in the Creator Store. Throttles at 60 requests per
 minute.

CreatorStoreProduct

The resource path of the creator store product.

 Format: `creator-store-products/{creator_store_product_id}`

The base price of the product. For more information, see
 [Money](/cloud/reference/types#money). Each product type (such as
 `pluginAssetId`) supports a set of specific prices. Currently, only USD is
 supported.

 The actual purchase price is based on this base price, but often differs
 slightly due to locale-specific considerations.

 Set this to zero to make the product free.

basePrice

The effective purchase price for the user, after factoring in
 locale-specific considerations.

purchasePrice

Whether the product is considered published, from the seller's perspective.

published

Restrictions applied to the product. A product can have multiple
 restrictions active at one time.

Possible values:

  | Value | Description |
  | --- | --- |
  | RESTRICTION_UNSPECIFIED | Unspecified restriction. |
  | SOLD_ITEM_RESTRICTED | The item being sold has been restricted by Roblox Details may be available by looking up that item directly. |
  | SELLER_TEMPORARILY_RESTRICTED | The product is restricted because the seller's account is temporarily restricted by Roblox. |
  | SELLER_PERMANENTLY_RESTRICTED | The product is restricted because the seller's account is permanently restricted by Roblox. |
  | SELLER_NO_LONGER_ACTIVE | The product is restricted because the seller's account was deleted or is otherwise no longer active. |

restrictions

Whether the product is purchasable.

 For this value to be true, `published` must be true and `restrictions` must
 be empty.

purchasable

userSeller

groupSeller

The Creator Store product is a model with this asset ID.

modelAssetId

The Creator Store product is a plugin with this asset ID.

 Supported base prices in USD: 0, 4.99, 5.99, 6.99, 7.99, 8.99, 9.99,
 10.99, 11.99, 12.99, 13.99, 14.99, 15.99, 16.99, 17.99, 18.99, 19.99,
 24.99, 29.99, 34.99, 39.99, 44.99, 49.99, 59.99, 69.99, 79.99, 89.99,
 99.99, 149.99, 199.99, 249.99

pluginAssetId

The Creator Store product is an audio file with this asset ID.

audioAssetId

The Creator Store product is a decal with this asset ID.

decalAssetId

The Creator Store product is a mesh part with this asset ID.

meshPartAssetId

The Creator Store product is a video with this asset ID.

videoAssetId

The Creator Store product is a font family with this asset ID.

fontFamilyAssetId

The resource path of the data store.

 Format: `universes/{universe_id}/data-stores/{data_store_id}`

The timestamp when the data store was created.

createTime

The ID of the data store. Matches the last segment of the path.

DataStoreEntry

The resource path of the data store entry.

 Formats:
 * `universes/{universe_id}/data-stores/{data_store_id}/entries/{data_store_entry_id}`
 * `universes/{universe_id}/data-stores/{data_store_id}/scopes/{data_store_scope_id}/entries/{data_store_entry_id}`

The timestamp when the data store entry was created.

The revision ID of the data store entry.

 A new revision is committed whenever the data store entry is changed in any
 way.

 The format is an arbitrary string.
 Example: "foo"

revisionId

The timestamp when the revision was created.

revisionCreateTime

The state of the data store entry.

Possible values:

  | Value | Description |
  | --- | --- |
  | STATE_UNSPECIFIED | The default value. This value is used if the state is omitted. |
  | ACTIVE | The default state of a newly created data store entry. |
  | DELETED | The data store entry is marked as deleted. At some point in the future, it will be permanently deleted. |

state

This checksum is computed by the server based on the value of other
 fields, and may be sent on update and delete requests (and potentially
 on certain custom methods) to ensure the client has an up-to-date
 value before proceeding.

etag

value

The resource ID of the entry.

 This matches the last segment of the resource path, and is provided
 only for convenience.

users

An arbitrary set of attributes associated with the entry.

attributes

Represents a decimal number in a form similar to scientific notation.

 Examples:
  - 17            === `{significand: 17   exponent: 0} (or just {significand:
    17})`
  - -0.005        === `{significand: -5   exponent: -3}`
  - 33.5 million  === `{significand: 335  exponent: 5}`
  - 11/8 (1.375)  === `{significand: 1375 exponent: -3}`

 Note that the range of a Decimal exceeds that of a JSON `number` (double), as
 well as that of a `decimal64`.

Decimal

significand

Represents the position of the decimal point within the significand.

 When the exponent is 0, the value of the Decimal is simply the value of
 `significand`.

 When the exponent is greater than 0, represents the number of trailing
 zeroes after the significant digits.

 When the exponent is less than 0, represents how many of the significant
 digits (and implicit leading zeroes, as needed) come after the decmial
 point.

exponent

DeclineGroupJoinRequestRequest

Discards read items from the front of the queue.

DiscardMemoryStoreQueueItemsRequest

The `readId` of the previous read operation for which to discard read
 items.

readId

Represents metadata about the long-running operation corresponding to a
 FlushMemoryStore request.

 This is the type of the `Operation.metadata` field in the response to
 `GetOperation` requests for FlushMemoryStore operations.

FlushMemoryStoreMetadata

FlushMemoryStoreRequest

Returns a FlushMemoryStoreResponse object.

FlushMemoryStoreResponse

Represents metadata about the long-running operation corresponding to a
 GenerateUserThumbnail request.

 This is the type of the `Operation.metadata` field in the response to
 `GetOperation` requests for GenerateUserThumbnail operations.

GenerateUserThumbnailMetadata

Returns the URL for the user's avatar thumbnail.

GenerateUserThumbnailResponse

imageUri

Represents metadata about the long-running operation corresponding to a
 GetInstance request.

 This is the type of the `Operation.metadata` field in the response to
 `GetOperation` requests for GetInstance operations.

GetInstanceMetadata

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

GoogleProtobufAny

@type

A mini-community within Roblox for communication, discussions, and more.

Group

The resource path of the group.

 Format: `groups/{group_id}`

The timestamp when the group was created.

The timestamp when the group was last updated.

updateTime

The name of the group.

 Must be non-empty. Has a maximum limit of 50 characters.

displayName

The description of the group.

 Has a maximum limit of 1000 characters.

description

The resource path of the owner.

 If the group is abandoned and has no owner, this field is not returned.

owner

The total number of members within a group.

memberCount

publicEntryAllowed

Whether the group is locked.

 A locked group is a group that has been
 moderated/banned by Roblox.

locked

Whether the group has the verified badge.

verified

A request to join a group.

 The `acceptRequests` permission is required.

GroupJoinRequest

The resource path of the group join request.

 Format: `groups/{group_id}/join-requests/{group_join_request_id}`

The timestamp when the group join request was created.

user

GroupMembership

The resource path of the group membership.

 Format: `groups/{group_id}/memberships/{group_membership_id}`

The timestamp when the group membership was created.

The timestamp when the group membership was last updated.

The resource path of a member of the group.

The resource path for the role of the group member.

role

A configurable property to grant specific privileges for members within a
 group.

GroupRole

The resource path of the group role.

 Format: `groups/{group_id}/roles/{group_role_id}`

The timestamp when the group role was last updated.

 Visible only to owners of the group.

The name of the role.

 Has a maximum limit of 100 characters. Names above the limit are
 rejected.

The description of the role.

 Has a maximum limit of 1000 characters. Strings above the limit are
 rejected. Visible only to owners of the group.

The rank of the role.

 The minimum value is 0. The maximum value is 255.

rank

Total number of members within a role.

 This field is not returned for guest roles.

The permissions granted for this role.

 This value is populated based on the read scope and role of the authorized
 user or API key creator. If the user or creator is the owner of the parent
 group, they are able to view all role permissions in the group. If the user
 or creator is a member of the parent group, they are able to view their
 role's permissions in the group. Anyone can view guest permissions. In
 the case that someone can't view the permissions, this field is not
 returned.

permissions

GroupRole_RolePermissions

viewWallPosts

createWallPosts

deleteWallPosts

viewGroupShout

createGroupShout

changeRank

acceptRequests

exileMembers

manageRelationships

viewAuditLog

spendGroupFunds

advertiseGroup

createAvatarItems

manageAvatarItems

manageGroupUniverses

viewUniverseAnalytics

createApiKeys

manageApiKeys

A single status post on a group that can hold important group updates or
 other information.

GroupShout

The resource path of the group shout.

 Format: `groups/{group_id}/shout`

The timestamp when the group shout was created.

The timestamp when the group shout was last updated.

The shout content.

 Has a maximum limit of 255 characters.

content

The resource path for the poster of the group shout.

 If the group is abandoned, has no owner, and has never had a shout, this
 field is not returned.

poster

Increments the entry value.

 If the value is not numeric, this request fails.

IncrementDataStoreEntryRequest

The amount by which to increment the entry value. Both the existing value
 and the increment amount must be integers.

amount

Users associated with the entry.

 If this is not provided, existing user IDs are cleared.

An arbitrary set of attributes associated with the entry.

 If this is not provided, existing attributes are cleared.

IncrementOrderedDataStoreEntryRequest

Instance

The resource path of the instance.

 Format: `universes/{universe_id}/places/{place_id}/instances/{instance_id}`

whether the instance has any children instance

hasChildren

engineInstance

Represents an item in a user's inventory.

InventoryItem

The resource path of the inventory item.

 Format: `users/{user_id}/inventory-items/{inventory_item_id}`

assetDetails

badgeDetails

gamePassDetails

Populated if this item is a private server.

privateServerDetails

Specific fields only applicable to assets

InventoryItem_AssetDetails

assetId

The specific asset type of this item.

Possible values:

  | Value | Description |
  | --- | --- |
  | INVENTORY_ITEM_ASSET_TYPE_UNSPECIFIED | Default InventoryItemAssetType |
  | CLASSIC_TSHIRT | Classic Tshirt |
  | AUDIO | Audio |
  | HAT | Hat |
  | MODEL | Model |
  | CLASSIC_SHIRT | Classic Shirt |
  | CLASSIC_PANTS | Classic Pants |
  | DECAL | Decal |
  | CLASSIC_HEAD | Classic Head |
  | FACE | Face |
  | GEAR | Gear |
  | ANIMATION | Animation |
  | TORSO | Torso |
  | RIGHT_ARM | Right Arm |
  | LEFT_ARM | Left Arm |
  | LEFT_LEG | Left Leg |
  | RIGHT_LEG | Right Leg |
  | PACKAGE | Package |
  | PLUGIN | Plugin |
  | MESH_PART | Mesh Part |
  | HAIR_ACCESSORY | Hair Accessory |
  | FACE_ACCESSORY | Face Accessory |
  | NECK_ACCESSORY | Neck Accessory |
  | SHOULDER_ACCESSORY | Shoulder Accessory |
  | FRONT_ACCESSORY | Front Accessory |
  | BACK_ACCESSORY | Back Accessory |
  | WAIST_ACCESSORY | Waist Accessory |
  | CLIMB_ANIMATION | Climb Animation |
  | DEATH_ANIMATION | Death Animation |
  | FALL_ANIMATION | Fall Animation |
  | IDLE_ANIMATION | Idle Animation |
  | JUMP_ANIMATION | Jump Animation |
  | RUN_ANIMATION | Run Animation |
  | SWIM_ANIMATION | Swim Animation |
  | WALK_ANIMATION | Walk Animation |
  | POSE_ANIMATION | Pose Animation |
  | EMOTE_ANIMATION | Emote Animation |
  | VIDEO | Video |
  | TSHIRT_ACCESSORY | Tshirt Accessory |
  | SHIRT_ACCESSORY | Shirt Accessory |
  | PANTS_ACCESSORY | Pants Accessory |
  | JACKET_ACCESSORY | Jacket Accessory |
  | SWEATER_ACCESSORY | Sweater Accessory |
  | SHORTS_ACCESSORY | Shorts Accessory |
  | LEFT_SHOE_ACCESSORY | Left Shoe Accessory |
  | RIGHT_SHOE_ACCESSORY | Right Shoe Accessory |
  | DRESS_SKIRT_ACCESSORY | Dress Skirt Accessory |
  | EYEBROW_ACCESSORY | Eyebrow Accessory |
  | EYELASH_ACCESSORY | Eyelash Accessory |
  | MOOD_ANIMATION | Mood Animation |
  | DYNAMIC_HEAD | Dynamic Head |
  | CREATED_PLACE | Created Place |
  | PURCHASED_PLACE | Purchased Place |

inventoryItemAssetType

A unique ID that identifies an instance or "copy" of the asset that's
 owned by a user.

instanceId

Additional details if this asset is a collectible. Otherwise, this
 attribute will be omitted.

collectibleDetails

Specific fields that are applicable to a badge.

InventoryItem_BadgeDetails

badgeId

Specific fields that are applicable to a collectible.

InventoryItem_CollectibleDetails

A unique ID of a Roblox item that is a collectible.

itemId

A unique ID of an individual copy of a collectible with ownership tied
 to a group or user.

The instance state of this specific Collectible Item Instance which
 affects whether it can be resold or traded.

Possible values:

  | Value | Description |
  | --- | --- |
  | COLLECTIBLE_ITEM_INSTANCE_STATE_UNSPECIFIED | Default CollectibleItemInstanceState |
  | AVAILABLE | Collectible item is available for all actions |
  | HOLD | Collectible item is on hold (can't be resold or traded) |

instanceState

If the asset is a Limited, a user-visible number that shows this item is
 the nth replica of the asset. Otherwise, this attribute will be omitted.

DataStore

Attributes

DataStore

List Data Stores
Beta

DataStore

Snapshot Data Stores
Beta

DataStore

Attributes

DataStore

List Data StoresBeta

DataStore

Snapshot Data StoresBeta

List Data Stores
Beta

Snapshot Data Stores
Beta