MemoryStoreQueueItem

Attributes

pathstring
dataJSON value
prioritynumber

One of the following for expiration:

ttlstring
Input Only
expireTimestring
Output Only
idstring
Output Only
Base URL
https://apis.roblox.com
The MemoryStoreQueueItem Resource
{

  "path": "universes/123/memory-store/queues/some-memory-store-queue-id/items/some-memory-store-queue-item-id",

  "data": "JSON value",

  "priority": "number",

  "ttl": "3s",

  "id": "string"

}

MemoryStoreQueueItem

Create Memory Store Queue Item
Beta

POST /cloud/v2/universes/{universe_id}/memory-store/queues/{queue_id}/items
Scopes
universe.memory-store.queue:write
RequestPath Parameters
universe_idstring
Required
queue_idstring
Required
Request BodyMemoryStoreQueueItem
ResponseMemoryStoreQueueItem
POST /cloud/v2/universes/{universe_id}/memory-store/queues/{queue_id}/items
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/memory-store/queues/{queue_id}/items' \

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

  -H 'Content-Type: application/json' \

  --data '{

  "data": "JSON value",

  "priority": "number",

  "ttl": "3s"

}'
Response
{

  "path": "universes/123/memory-store/queues/some-memory-store-queue-id/items/some-memory-store-queue-item-id",

  "data": "JSON value",

  "priority": "number",

  "id": "string"

}

MemoryStoreQueueItem

Discard Memory Store Queue Items
Beta

POST /cloud/v2/universes/{universe_id}/memory-store/queues/{queue_id}/items:discard
Scopes
universe.memory-store.queue:discard
RequestPath Parameters
universe_idstring
Required
queue_idstring
Required
Request Body
readIdstring
POST /cloud/v2/universes/{universe_id}/memory-store/queues/{queue_id}/items:discard
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/memory-store/queues/{queue_id}/items:discard' \

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

  -H 'Content-Type: application/json' \

  --data '{

  "readId": "string"

}'

MemoryStoreQueueItem

Read Memory Store Queue Items
Beta

GET /cloud/v2/universes/{universe_id}/memory-store/queues/{queue_id}/items:read
Scopes
universe.memory-store.queue:dequeue
RequestPath Parameters
universe_idstring
Required
queue_idstring
Required
Query Parameters
countnumber
allOrNothingboolean
invisibilityWindowstring
Response
readIdstring
GET /cloud/v2/universes/{universe_id}/memory-store/queues/{queue_id}/items:read
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/memory-store/queues/{queue_id}/items:read?count={integer}&allOrNothing={boolean}&invisibilityWindow={string}' \

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

  "readId": "string",

  "items": [

    {

      "path": "universes/123/memory-store/queues/some-memory-store-queue-id/items/some-memory-store-queue-item-id",

      "data": "JSON value",

      "priority": "number",

      "id": "string"

    }

  ]

}