GET /v1/universes/{universeId}/standard-datastores — datastores-api/v1

List data stores in an experience

Returns a list of an experience's data stores.

Endpoint

Method: GET

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

Servers:

https://apis.roblox.com/datastores

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.
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.
prefix	query	false	Provide to return only data stores with this prefix.

[
  {
    "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": "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": 1
    }
  },
  {
    "name": "prefix",
    "in": "query",
    "description": "Provide to return only data stores with this prefix. ",
    "schema": {
      "type": "string",
      "nullable": true
    }
  }
]

Responses

Status	Description
200

{
  "200": {
    "description": "",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "description": "An array of data stores in the target experience.",
              "items": {
                "$ref": "#/components/schemas/DataStore"
              }
            },
            "nextPageCursor": {
              "type": "string",
              "nullable": true,
              "description": "Indicates that there is more data available in the requested result set."
            }
          },
          "example": "{\n  \"datastores\": [\n    {\n      \"name\": \"PlayerInventory\",\n      \"createdTime\": \"2022-02-18T22:38:59.9244932Z\"\n    },\n    {\n      \"name\": \"PlayerExperience\",\n      \"createdTime\": \"2022-02-18T23:00:10.4773508Z\"\n    },\n    {\n      \"name\": \"PlayerWeapons\",\n      \"createdTime\": \"2022-02-18T23:00:22.3725681Z\"\n    },\n    {\n      \"name\": \"PlayerArmor\",\n      \"createdTime\": \"2022-02-18T22:59:33.8472882Z\"\n    },\n    {\n      \"name\": \"PlayerHP\",\n      \"createdTime\": \"2022-02-18T22:58:47.6904028Z\"\n    }\n  ],\n  \"nextPageCursor\": \"...\"\n}\n"
        },
        "encoding": {
          "metadata": {
            "contentType": "application/json; charset=utf-8; content-length=388;"
          }
        }
      }
    }
  }
}

Authentication

{
  "security": [
    {
      "roblox-api-key": [
        "universe-datastores.control:list"
      ]
    }
  ],
  "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.",
      "in": "header",
      "name": "x-api-key"
    }
  }
}

DataStore

Complete Operation Definition

{
  "tags": [
    "Datastores"
  ],
  "summary": "List data stores in an experience",
  "description": "Returns a list of an experience's data stores.",
  "operationId": "Datastores_ListDatastoresAsync",
  "x-roblox-cloud-api-operation-name": "List Data Stores",
  "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": "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": 1
      }
    },
    {
      "name": "prefix",
      "in": "query",
      "description": "Provide to return only data stores with this prefix. ",
      "schema": {
        "type": "string",
        "nullable": true
      }
    }
  ],
  "responses": {
    "200": {
      "description": "",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "description": "An array of data stores in the target experience.",
                "items": {
                  "$ref": "#/components/schemas/DataStore"
                }
              },
              "nextPageCursor": {
                "type": "string",
                "nullable": true,
                "description": "Indicates that there is more data available in the requested result set."
              }
            },
            "example": "{\n  \"datastores\": [\n    {\n      \"name\": \"PlayerInventory\",\n      \"createdTime\": \"2022-02-18T22:38:59.9244932Z\"\n    },\n    {\n      \"name\": \"PlayerExperience\",\n      \"createdTime\": \"2022-02-18T23:00:10.4773508Z\"\n    },\n    {\n      \"name\": \"PlayerWeapons\",\n      \"createdTime\": \"2022-02-18T23:00:22.3725681Z\"\n    },\n    {\n      \"name\": \"PlayerArmor\",\n      \"createdTime\": \"2022-02-18T22:59:33.8472882Z\"\n    },\n    {\n      \"name\": \"PlayerHP\",\n      \"createdTime\": \"2022-02-18T22:58:47.6904028Z\"\n    }\n  ],\n  \"nextPageCursor\": \"...\"\n}\n"
          },
          "encoding": {
            "metadata": {
              "contentType": "application/json; charset=utf-8; content-length=388;"
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "roblox-api-key": [
        "universe-datastores.control:list"
      ]
    }
  ],
  "x-roblox-scopes": [
    {
      "name": "universe-datastores.control:list"
    }
  ],
  "x-roblox-cloud-api-operation": true,
  "x-roblox-lua-equivalent": "DataStoreService:ListDataStoresAsync",
  "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\" \\\n--header \"x-api-key: ${API_KEY}\" \\\n--get \\\n-d \"prefix=Player\" \\\n-d \"limit=5\""
    }
  ],
  "x-roblox-rate-limits": {
    "description": "See [Throttling](/cloud/guides/data-stores/throttling.md)."
  },
  "x-roblox-recommended-alternatives": [
    {
      "url": "https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores",
      "httpMethod": "GET"
    }
  ]
}

GET /v1/universes/{universeId}/standard-datastores — datastores-api/v1

Endpoint

Parameters

Responses

Authentication

Related Schemas

Complete Operation Definition