GET /datastores/v1/universes/{universeId}/standard-datastores/datastore/entries — openapi

List entries

Returns a list of entry keys within a data store.

Entries marked deleted with a tombstone version are still included in the response if they have yet to be permanently deleted.

Endpoint

Method: GET

Path: /datastores/v1/universes/{universeId}/standard-datastores/datastore/entries

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
universeId	path	true	The identifier of the experience with data stores that you want to access. You can find your experience's universe ID on Creator Hub.
datastoreName	query	false	The name of the data store.
scope	query	false	The value is `global` by default. See Scopes.
allScopes	query	false	Set to true to return keys from all scopes.
prefix	query	false	Provide to return only keys with this prefix.
cursor	query	false	Provide to request the next set of data.
limit	query	false	The maximum number of items to return. Each call only reads one partition, so it can return fewer than the given value when running out of objectives on one partition.

[
  {
    "name": "universeId",
    "in": "path",
    "required": true,
    "description": "The identifier of the experience with data stores that you want to access. You can find your experience's universe ID on Creator Hub.",
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "name": "datastoreName",
    "in": "query",
    "description": "The name of the data store.",
    "schema": {
      "type": "string",
      "nullable": true
    }
  },
  {
    "name": "scope",
    "in": "query",
    "description": "The value is `global` by default. See [Scopes](/cloud-services/data-stores/index.md#scopes).",
    "schema": {
      "type": "string",
      "nullable": true
    }
  },
  {
    "name": "allScopes",
    "in": "query",
    "description": "Set to true to return keys from all scopes.",
    "schema": {
      "type": "boolean",
      "default": false
    }
  },
  {
    "name": "prefix",
    "in": "query",
    "description": "Provide to return only keys with this prefix.",
    "schema": {
      "type": "string",
      "nullable": true
    }
  },
  {
    "name": "cursor",
    "in": "query",
    "description": "Provide to request the next set of data.",
    "schema": {
      "type": "string",
      "nullable": true
    }
  },
  {
    "name": "limit",
    "in": "query",
    "description": "The maximum number of items to return. Each call only reads one partition, so it can return fewer than the given value when running out of objectives on one partition.",
    "schema": {
      "type": "integer",
      "format": "int32",
      "default": 16
    }
  }
]

Responses

Status	Description
200

{
  "200": {
    "description": "",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "keys": {
              "type": "array",
              "description": "An array of entry keys within the target data store.",
              "items": {
                "type": "string"
              }
            },
            "nextPageCursor": {
              "type": "string",
              "nullable": true,
              "description": "Indicates that there is more data available in the requested result set."
            }
          },
          "example": "{\n  \"keys\": [\n    {\n      \"key\": \"269323\"\n    }\n  ],\n  \"nextPageCursor\": \"eyJ2ZXJzaW9uIjoxLCJjdXJzb3IiOiIzIyJ9\"\n}\n"
        },
        "encoding": {
          "metadata": {
            "contentType": "application/json; charset=utf-8; content-length=388;"
          }
        }
      }
    }
  }
}

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": {}
        }
      }
    }
  }
}

Complete Operation Definition

{
  "tags": [
    "Data and memory stores"
  ],
  "summary": "List entries",
  "description": "Returns a list of entry keys within a data store.\n\n Entries marked deleted with a tombstone version are still included in the response if they have yet to be permanently deleted.",
  "operationId": "Entries_ListKeysAsync",
  "x-roblox-cloud-api-operation-name": "List Entries",
  "x-roblox-stability": "BETA",
  "parameters": [
    {
      "name": "universeId",
      "in": "path",
      "required": true,
      "description": "The identifier of the experience with data stores that you want to access. You can find your experience's universe ID on Creator Hub.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "datastoreName",
      "in": "query",
      "description": "The name of the data store.",
      "schema": {
        "type": "string",
        "nullable": true
      }
    },
    {
      "name": "scope",
      "in": "query",
      "description": "The value is `global` by default. See [Scopes](/cloud-services/data-stores/index.md#scopes).",
      "schema": {
        "type": "string",
        "nullable": true
      }
    },
    {
      "name": "allScopes",
      "in": "query",
      "description": "Set to true to return keys from all scopes.",
      "schema": {
        "type": "boolean",
        "default": false
      }
    },
    {
      "name": "prefix",
      "in": "query",
      "description": "Provide to return only keys with this prefix.",
      "schema": {
        "type": "string",
        "nullable": true
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "description": "Provide to request the next set of data.",
      "schema": {
        "type": "string",
        "nullable": true
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of items to return. Each call only reads one partition, so it can return fewer than the given value when running out of objectives on one partition.",
      "schema": {
        "type": "integer",
        "format": "int32",
        "default": 16
      }
    }
  ],
  "responses": {
    "200": {
      "description": "",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "keys": {
                "type": "array",
                "description": "An array of entry keys within the target data store.",
                "items": {
                  "type": "string"
                }
              },
              "nextPageCursor": {
                "type": "string",
                "nullable": true,
                "description": "Indicates that there is more data available in the requested result set."
              }
            },
            "example": "{\n  \"keys\": [\n    {\n      \"key\": \"269323\"\n    }\n  ],\n  \"nextPageCursor\": \"eyJ2ZXJzaW9uIjoxLCJjdXJzb3IiOiIzIyJ9\"\n}\n"
          },
          "encoding": {
            "metadata": {
              "contentType": "application/json; charset=utf-8; content-length=388;"
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "roblox-api-key": []
    }
  ],
  "x-roblox-scopes": [
    {
      "name": "universe-datastores.objects:list"
    }
  ],
  "x-roblox-cloud-api-operation": true,
  "x-roblox-lua-equivalent": "DataStore:ListKeysAsync",
  "x-roblox-cloud-api-operation-code-samples": [
    {
      "language": "curl",
      "script": "curl --include --location --request GET \"https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries\" \\\n--header \"x-api-key: ${API_KEY}\" \\\n--get \\\n-d \"datastoreName=Coins\" \\\n-d \"prefix=\" \\\n-d \"limit=5\""
    }
  ],
  "x-roblox-rate-limits": {
    "description": "See [Throttling](/cloud/guides/data-stores/throttling.md).",
    "perApiKeyOwner": {
      "period": "MINUTE",
      "maxInPeriod": 5000
    }
  },
  "x-roblox-recommended-alternatives": [
    {
      "url": "https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries",
      "httpMethod": "GET",
      "documentationUrl": "https://create.roblox.com/docs/cloud/reference/features/storage#Cloud_ListDataStoreEntries__Using_Universes"
    },
    {
      "url": "https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries",
      "httpMethod": "GET",
      "documentationUrl": "https://create.roblox.com/docs/cloud/reference/features/storage#Cloud_ListDataStoreEntries__Using_Universes_DataStores"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/storage#Entries_ListKeysAsync"
  }
}