MemoryStoreSortedMapItem

Attributes

pathstring
valueJSON value
etagstring
Output Only

One of the following for expiration:

ttlstring
Input Only
expireTimestring
Output Only
idstring

One of the following for sortKey:

stringSortKeystring
numericSortKeynumber
Base URL
https://apis.roblox.com/cloud
The MemoryStoreSortedMapItem Resource
{

  "path": "string",

  "value": "JSON value",

  "etag": "string",

  "ttl": "3s",

  "id": "string",

  "stringSortKey": "string"

}

MemoryStoreSortedMapItem

List Memory Store Sorted Map Items

GET /cloud/v2/universes/{universe}/memory-store/sorted-maps/{sorted-map}/items
Scopes
universe.memory-store.sorted-map:read
RequestPath Parameters
universestring
Required
sorted-mapstring
Required
Query Parameters
maxPageSizenumber
pageTokenstring
orderBystring
filterstring
Response
nextPageTokenstring
GET /cloud/v2/universes/{universe}/memory-store/sorted-maps/{sorted-map}/items
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe}/memory-store/sorted-maps/{sorted-map}/items?maxPageSize=1&pageToken={string}&orderBy={string}&filter={string}' \

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

  "memoryStoreSortedMapItems": [

    {

      "path": "string",

      "value": "JSON value",

      "etag": "string",

      "id": "string",

      "stringSortKey": "string"

    }

  ],

  "nextPageToken": "string"

}

MemoryStoreSortedMapItem

Create Memory Store Sorted Map Item

POST /cloud/v2/universes/{universe}/memory-store/sorted-maps/{sorted-map}/items
Scopes
universe.memory-store.sorted-map:write
RequestPath Parameters
universestring
Required
sorted-mapstring
Required
Query Parameters
idstring
Request BodyMemoryStoreSortedMapItem
ResponseMemoryStoreSortedMapItem
POST /cloud/v2/universes/{universe}/memory-store/sorted-maps/{sorted-map}/items
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe}/memory-store/sorted-maps/{sorted-map}/items?id=Hello!' \

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

  --data '{ \

  "value": "JSON value", \

  "ttl": "3s", \

  "id": "string", \

  "stringSortKey": "string" \

}'
Response
{

  "path": "string",

  "value": "JSON value",

  "etag": "string",

  "id": "string",

  "stringSortKey": "string"

}

MemoryStoreSortedMapItem

Get Memory Store Sorted Map Item

GET /cloud/v2/universes/{universe}/memory-store/sorted-maps/{sorted-map}/items/{item}
Scopes
universe.memory-store.sorted-map:read
RequestPath Parameters
universestring
Required
sorted-mapstring
Required
itemstring
Required
ResponseMemoryStoreSortedMapItem
GET /cloud/v2/universes/{universe}/memory-store/sorted-maps/{sorted-map}/items/{item}
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe}/memory-store/sorted-maps/{sorted-map}/items/{item}' \

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

  "path": "string",

  "value": "JSON value",

  "etag": "string",

  "id": "string",

  "stringSortKey": "string"

}

MemoryStoreSortedMapItem

Delete Memory Store Sorted Map Item

DELETE /cloud/v2/universes/{universe}/memory-store/sorted-maps/{sorted-map}/items/{item}
Scopes
universe.memory-store.sorted-map:write
RequestPath Parameters
universestring
Required
sorted-mapstring
Required
itemstring
Required
DELETE /cloud/v2/universes/{universe}/memory-store/sorted-maps/{sorted-map}/items/{item}
curl -L -X DELETE 'https://apis.roblox.com/cloud/v2/universes/{universe}/memory-store/sorted-maps/{sorted-map}/items/{item}' \

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

MemoryStoreSortedMapItem

Update Memory Store Sorted Map Item

PATCH /cloud/v2/universes/{universe}/memory-store/sorted-maps/{sorted-map}/items/{item}
Scopes
universe.memory-store.sorted-map:write
RequestPath Parameters
universestring
Required
sorted-mapstring
Required
itemstring
Required
Query Parameters
allowMissingboolean
Request BodyMemoryStoreSortedMapItem
ResponseMemoryStoreSortedMapItem
PATCH /cloud/v2/universes/{universe}/memory-store/sorted-maps/{sorted-map}/items/{item}
curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe}/memory-store/sorted-maps/{sorted-map}/items/{item}?allowMissing={boolean}' \

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

  --data '{ \

  "value": "JSON value", \

  "ttl": "3s", \

  "id": "string", \

  "stringSortKey": "string" \

}'
Response
{

  "path": "string",

  "value": "JSON value",

  "etag": "string",

  "id": "string",

  "stringSortKey": "string"

}