POST /cloud/v2/universes/{universe_id}/memory-store/queues/{queue_id}/items — cloud.docs

Create Memory Store Queue Item

Creates a new queue item.

If ttl is set, the item will automatically be removed from the queue after the time interval specified.

If a numerical priority is set, the item will be inserted into the queue based on the priority value. The higher the value, the closer to the front of the queue the item will be. If priority values are the same then the item will be inserted after existing values with the same priority.

Endpoint

Method: POST

Path: /cloud/v2/universes/{universe_id}/memory-store/queues/{queue_id}/items

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
universe_id	path	true	The universe ID.
queue_id	path	true	The queue ID.

[
  {
    "name": "universe_id",
    "in": "path",
    "description": "The universe ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "queue_id",
    "in": "path",
    "description": "The queue ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/MemoryStoreQueueItem"
      }
    }
  },
  "required": true
}

Responses

Status	Description
200	OK

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/MemoryStoreQueueItem"
        }
      }
    }
  }
}

Authentication

{
  "security": [],
  "securitySchemes": {}
}

MemoryStoreQueueItem

Complete Operation Definition

{
  "tags": [
    "Cloud"
  ],
  "summary": "Create Memory Store Queue Item",
  "description": "Creates a new queue item.\n\nIf `ttl` is set, the item will automatically be removed from the queue\nafter the time interval specified.\n\nIf a numerical `priority` is set, the item will be inserted into the queue\nbased on the priority value. The higher the value, the closer to the front\nof the queue the item will be. If priority values are the same then the\nitem will be inserted after existing values with the same priority.",
  "operationId": "Cloud_CreateMemoryStoreQueueItem",
  "parameters": [
    {
      "name": "universe_id",
      "in": "path",
      "description": "The universe ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "queue_id",
      "in": "path",
      "description": "The queue ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/MemoryStoreQueueItem"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/MemoryStoreQueueItem"
          }
        }
      }
    }
  },
  "x-visibility": "STABLE",
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "x-roblox-scopes": [
    {
      "name": "memory-store.queue:add"
    }
  ],
  "x-roblox-docs": {
    "category": "Data and memory stores",
    "methodProperties": {
      "scopes": [
        "memory-store.queue:add"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/MemoryStoreQueueItem",
      "name": "MemoryStoreQueueItem"
    }
  }
}