DataStore

Attributes

pathstring
createTimestring
Output Only
idstring
Output Only
Base URL

https://apis.roblox.com/cloud
The DataStore Resource

{
"path": "universes/123/data-stores/some-data-store",
"createTime": "2023-07-05T12:34:56Z",
"id": "string"
}

DataStore

List Data Stores
Beta

GET /cloud/v2/universes/{universe}/data-stores
Scopes
universe-datastores.control:list
RequestPath Parameters
universestring
Required
Query Parameters
maxPageSizenumber
pageTokenstring
filterstring
Response
nextPageTokenstring
GET /cloud/v2/universes/{universe}/data-stores

curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe}/data-stores?maxPageSize=10&pageToken={string}&filter={string}' \
-H 'x-api-key: {your-api-key}'
Response

{
"dataStores": [
{
"path": "universes/123/data-stores/some-data-store",
"createTime": "2023-07-05T12:34:56Z",
"id": "string"
}
],
"nextPageToken": "string"
}

DataStore

Snapshot Data Stores
Beta

POST /cloud/v2/universes/{universe}/data-stores:snapshot
Scopes
universe-datastores.control:snapshot
RequestPath Parameters
universestring
Required
Request Body
Response
newSnapshotTakenboolean
latestSnapshotTimestring
POST /cloud/v2/universes/{universe}/data-stores:snapshot

curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe}/data-stores:snapshot' \
-H 'x-api-key: {your-api-key}' \
--data '{}'
Response

{
"newSnapshotTaken": true,
"latestSnapshotTime": "2023-07-05T12:34:56Z"
}