GET /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id} — openapi

Get Memory Store Sorted Map Item

Gets and returns the value of the given key in the map.

Endpoint

Method: GET

Path: /cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id}

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
universe_id	path	true	The universe ID.
sorted_map_id	path	true	The sorted-map ID.
item_id	path	true	The item ID.

[
  {
    "name": "universe_id",
    "in": "path",
    "description": "The universe ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "sorted_map_id",
    "in": "path",
    "description": "The sorted-map ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "item_id",
    "in": "path",
    "description": "The item ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Responses

Status	Description
200	OK

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

Authentication

{
  "security": [
    {
      "roblox-api-key": []
    }
  ],
  "securitySchemes": {
    "roblox-api-key": {
      "type": "apiKey",
      "description": "A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.",
      "name": "x-api-key",
      "in": "header"
    },
    "roblox-legacy-cookie": {
      "type": "apiKey",
      "description": "A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.",
      "in": "cookie",
      "name": ".ROBLOSECURITY"
    },
    "roblox-oauth2": {
      "type": "oauth2",
      "description": "Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.",
      "flows": {
        "authorizationCode": {
          "authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize",
          "tokenUrl": "https://apis.roblox.com/oauth/v1/token",
          "refreshUrl": "https://apis.roblox.com/oauth/v1/token",
          "scopes": {}
        }
      }
    }
  }
}

MemoryStoreSortedMapItem

Complete Operation Definition

{
  "tags": [
    "Data and memory stores"
  ],
  "summary": "Get Memory Store Sorted Map Item",
  "description": "Gets and returns the value of the given key in the map.",
  "operationId": "Cloud_GetMemoryStoreSortedMapItem",
  "parameters": [
    {
      "name": "universe_id",
      "in": "path",
      "description": "The universe ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "sorted_map_id",
      "in": "path",
      "description": "The sorted-map ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "item_id",
      "in": "path",
      "description": "The item ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/MemoryStoreSortedMapItem"
          }
        }
      }
    }
  },
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": true
  },
  "x-roblox-scopes": [
    {
      "name": "memory-store.sorted-map:read",
      "targetResourceSpecifier": "universes"
    },
    {
      "name": "memory-store.sorted-map:read"
    }
  ],
  "x-roblox-docs": {
    "category": "Data and memory stores",
    "methodProperties": {
      "scopes": [
        "memory-store.sorted-map:read"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/MemoryStoreSortedMapItem",
      "name": "MemoryStoreSortedMapItem"
    }
  },
  "x-roblox-stability": "STABLE",
  "x-roblox-rate-limits": {
    "perApiKeyOwner": {
      "period": "MINUTE",
      "maxInPeriod": 1000000
    }
  },
  "security": [
    {
      "roblox-api-key": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/storage#Cloud_GetMemoryStoreSortedMapItem"
  }
}