DataStoreEntry

  • RESOURCE PATHS
  • /cloud/v2/universes/{universe}/data-stores/{data-store}/entries
  • /cloud/v2/universes/{universe}/data-stores/{data-store}/scopes/{scope}/entries

Attributes

pathstring
createTimestring
Output Only
revisionIdstring
Immutable
Output Only
revisionCreateTimestring
Output Only
stateEnum<string>
Output Only
etagstring
valueJSON value
idstring
Output Only
usersarray<string>
attributesobject
Base URL
https://apis.roblox.com/cloud
The DataStoreEntry Resource
{

  "path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",

  "createTime": "2023-07-05T12:34:56Z",

  "revisionId": "string",

  "revisionCreateTime": "2023-07-05T12:34:56Z",

  "state": "STATE_UNSPECIFIED",

  "etag": "string",

  "value": "JSON value",

  "id": "string",

  "users": [

    "string"

  ],

  "attributes": "object"

}

DataStoreEntry

List Data Store Entries
Beta

GET /cloud/v2/universes/{universe}/data-stores/{data-store}/entries
Scopes
universe-datastores.objects:list
RequestPath Parameters
universestring
Required
data-storestring
Required
Query Parameters
maxPageSizenumber
pageTokenstring
filterstring
showDeletedboolean
Response
nextPageTokenstring
GET /cloud/v2/universes/{universe}/data-stores/{data-store}/entries
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe}/data-stores/{data-store}/entries?maxPageSize=10&pageToken={string}&filter={string}&showDeleted={boolean}' \

  -H 'x-api-key: {your-api-key}'
Response
{

  "dataStoreEntries": [

    {

      "path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",

      "createTime": "2023-07-05T12:34:56Z",

      "revisionId": "string",

      "revisionCreateTime": "2023-07-05T12:34:56Z",

      "state": "STATE_UNSPECIFIED",

      "etag": "string",

      "value": "JSON value",

      "id": "string",

      "users": [

        "string"

      ],

      "attributes": "object"

    }

  ],

  "nextPageToken": "string"

}

DataStoreEntry

Create Data Store Entry
Beta

POST /cloud/v2/universes/{universe}/data-stores/{data-store}/entries
Scopes
universe-datastores.objects:create
RequestPath Parameters
universestring
Required
data-storestring
Required
Query Parameters
idstring
Request BodyDataStoreEntry
ResponseDataStoreEntry
POST /cloud/v2/universes/{universe}/data-stores/{data-store}/entries
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe}/data-stores/{data-store}/entries?id=my-entry' \

  -H 'x-api-key: {your-api-key}' \

  --data '{ \

  "etag": "string", \

  "value": "JSON value", \

  "users": [ \

    "string" \

  ], \

  "attributes": "object" \

}'
Response
{

  "path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",

  "createTime": "2023-07-05T12:34:56Z",

  "revisionId": "string",

  "revisionCreateTime": "2023-07-05T12:34:56Z",

  "state": "STATE_UNSPECIFIED",

  "etag": "string",

  "value": "JSON value",

  "id": "string",

  "users": [

    "string"

  ],

  "attributes": "object"

}

DataStoreEntry

Get Data Store Entry
Beta

GET /cloud/v2/universes/{universe}/data-stores/{data-store}/entries/{entry}
Scopes
universe-datastores.objects:read
RequestPath Parameters
universestring
Required
data-storestring
Required
entrystring
Required
ResponseDataStoreEntry
GET /cloud/v2/universes/{universe}/data-stores/{data-store}/entries/{entry}
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe}/data-stores/{data-store}/entries/{entry}' \

  -H 'x-api-key: {your-api-key}'
Response
{

  "path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",

  "createTime": "2023-07-05T12:34:56Z",

  "revisionId": "string",

  "revisionCreateTime": "2023-07-05T12:34:56Z",

  "state": "STATE_UNSPECIFIED",

  "etag": "string",

  "value": "JSON value",

  "id": "string",

  "users": [

    "string"

  ],

  "attributes": "object"

}

DataStoreEntry

Delete Data Store Entry
Beta

DELETE /cloud/v2/universes/{universe}/data-stores/{data-store}/entries/{entry}
Scopes
universe-datastores.objects:delete
RequestPath Parameters
universestring
Required
data-storestring
Required
entrystring
Required
DELETE /cloud/v2/universes/{universe}/data-stores/{data-store}/entries/{entry}
curl -L -X DELETE 'https://apis.roblox.com/cloud/v2/universes/{universe}/data-stores/{data-store}/entries/{entry}' \

  -H 'x-api-key: {your-api-key}'

DataStoreEntry

Update Data Store Entry
Beta

PATCH /cloud/v2/universes/{universe}/data-stores/{data-store}/entries/{entry}
Scopes
universe-datastores.objects:update
RequestPath Parameters
universestring
Required
data-storestring
Required
entrystring
Required
Query Parameters
allowMissingboolean
Request BodyDataStoreEntry
ResponseDataStoreEntry
PATCH /cloud/v2/universes/{universe}/data-stores/{data-store}/entries/{entry}
curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe}/data-stores/{data-store}/entries/{entry}?allowMissing={boolean}' \

  -H 'x-api-key: {your-api-key}' \

  --data '{ \

  "etag": "string", \

  "value": "JSON value", \

  "users": [ \

    "string" \

  ], \

  "attributes": "object" \

}'
Response
{

  "path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",

  "createTime": "2023-07-05T12:34:56Z",

  "revisionId": "string",

  "revisionCreateTime": "2023-07-05T12:34:56Z",

  "state": "STATE_UNSPECIFIED",

  "etag": "string",

  "value": "JSON value",

  "id": "string",

  "users": [

    "string"

  ],

  "attributes": "object"

}

DataStoreEntry

Increment Data Store Entry
Beta

POST /cloud/v2/universes/{universe}/data-stores/{data-store}/entries/{entry}:increment
Scopes
universe-datastores.objects:createuniverse-datastores.objects:update
RequestPath Parameters
universestring
Required
data-storestring
Required
entrystring
Required
Request Body
amountnumber
usersarray<string>
attributesobject
ResponseDataStoreEntry
POST /cloud/v2/universes/{universe}/data-stores/{data-store}/entries/{entry}:increment
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe}/data-stores/{data-store}/entries/{entry}:increment' \

  -H 'x-api-key: {your-api-key}' \

  --data '{ \

  "amount": "number", \

  "users": [ \

    "string" \

  ], \

  "attributes": "object" \

}'
Response
{

  "path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",

  "createTime": "2023-07-05T12:34:56Z",

  "revisionId": "string",

  "revisionCreateTime": "2023-07-05T12:34:56Z",

  "state": "STATE_UNSPECIFIED",

  "etag": "string",

  "value": "JSON value",

  "id": "string",

  "users": [

    "string"

  ],

  "attributes": "object"

}

DataStoreEntry

List Data Store Entry Revisions
Beta

GET /cloud/v2/universes/{universe}/data-stores/{data-store}/entries/{entry}:listRevisions
Scopes
universe-datastores.versions:list
RequestPath Parameters
universestring
Required
data-storestring
Required
entrystring
Required
Query Parameters
maxPageSizenumber
pageTokenstring
filterstring
Response
nextPageTokenstring
GET /cloud/v2/universes/{universe}/data-stores/{data-store}/entries/{entry}:listRevisions
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe}/data-stores/{data-store}/entries/{entry}:listRevisions?maxPageSize=10&pageToken={string}&filter={string}' \

  -H 'x-api-key: {your-api-key}'
Response
{

  "dataStoreEntries": [

    {

      "path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",

      "createTime": "2023-07-05T12:34:56Z",

      "revisionId": "string",

      "revisionCreateTime": "2023-07-05T12:34:56Z",

      "state": "STATE_UNSPECIFIED",

      "etag": "string",

      "value": "JSON value",

      "id": "string",

      "users": [

        "string"

      ],

      "attributes": "object"

    }

  ],

  "nextPageToken": "string"

}