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
The MemoryStoreSortedMapItem Resource

{
"path": "universes/123/memory-store/sorted-maps/some-memory-store-sorted-map-id/items/some-memory-store-sorted-map-item-id",
"value": "JSON value",
"etag": "string",
"ttl": "3s",
"id": "string",
"stringSortKey": "string"
}

MemoryStoreSortedMapItem

List Memory Store Sorted Map Items
Beta

GET /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items
Scopes
universe.memory-store.sorted-map:read
RequestPath Parameters
universe_idstring
Required
sorted_map_idstring
Required
Query Parameters
maxPageSizenumber
pageTokenstring
orderBystring
filterstring
Response
nextPageTokenstring
GET /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items

curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items?maxPageSize=1&pageToken={string}&orderBy={string}&filter={string}' \
-H 'x-api-key: {your-api-key}'
Response

{
"memoryStoreSortedMapItems": [
{
"path": "universes/123/memory-store/sorted-maps/some-memory-store-sorted-map-id/items/some-memory-store-sorted-map-item-id",
"value": "JSON value",
"etag": "string",
"id": "string",
"stringSortKey": "string"
}
],
"nextPageToken": "string"
}

MemoryStoreSortedMapItem

Create Memory Store Sorted Map Item
Beta

POST /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items
Scopes
universe.memory-store.sorted-map:write
RequestPath Parameters
universe_idstring
Required
sorted_map_idstring
Required
Query Parameters
idstring
Request BodyMemoryStoreSortedMapItem
POST /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items

curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items?id=Hello!' \
-H 'x-api-key: {your-api-key}' \
-H 'Content-Type: application/json' \
--data '{
"value": "JSON value",
"ttl": "3s",
"id": "string",
"stringSortKey": "string"
}'
Response

{
"path": "universes/123/memory-store/sorted-maps/some-memory-store-sorted-map-id/items/some-memory-store-sorted-map-item-id",
"value": "JSON value",
"etag": "string",
"id": "string",
"stringSortKey": "string"
}

MemoryStoreSortedMapItem

Get Memory Store Sorted Map Item
Beta

GET /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id}
Scopes
universe.memory-store.sorted-map:read
RequestPath Parameters
universe_idstring
Required
sorted_map_idstring
Required
item_idstring
Required
GET /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id}

curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id}' \
-H 'x-api-key: {your-api-key}'
Response

{
"path": "universes/123/memory-store/sorted-maps/some-memory-store-sorted-map-id/items/some-memory-store-sorted-map-item-id",
"value": "JSON value",
"etag": "string",
"id": "string",
"stringSortKey": "string"
}

MemoryStoreSortedMapItem

Delete Memory Store Sorted Map Item
Beta

DELETE /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id}
Scopes
universe.memory-store.sorted-map:write
RequestPath Parameters
universe_idstring
Required
sorted_map_idstring
Required
item_idstring
Required
DELETE /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id}

curl -L -X DELETE 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id}' \
-H 'x-api-key: {your-api-key}'

MemoryStoreSortedMapItem

Update Memory Store Sorted Map Item
Beta

PATCH /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id}
Scopes
universe.memory-store.sorted-map:write
RequestPath Parameters
universe_idstring
Required
sorted_map_idstring
Required
item_idstring
Required
Query Parameters
allowMissingboolean
Request BodyMemoryStoreSortedMapItem
PATCH /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id}

curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id}?allowMissing={boolean}' \
-H 'x-api-key: {your-api-key}' \
-H 'Content-Type: application/json' \
--data '{
"value": "JSON value",
"ttl": "3s",
"id": "string",
"stringSortKey": "string"
}'
Response

{
"path": "universes/123/memory-store/sorted-maps/some-memory-store-sorted-map-id/items/some-memory-store-sorted-map-item-id",
"value": "JSON value",
"etag": "string",
"id": "string",
"stringSortKey": "string"
}