1 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

DataStoreLocation — openapi

Describes where an attribute value exists in DataStore.

Properties

NameTypeRequiredDescription
dataStoreNamestringfalseThe DataStore name.
scopestringfalseThe scope of the key in DataStore.
keyTemplatestringfalseThe key of a DataStore value, with {UserId} replaced by the player's actual ID when fetching values.
valuePathstringfalseA JSON path to a value if it lives in a JSON object.

Complete Schema

{
  "type": "object",
  "properties": {
    "dataStoreName": {
      "type": "string",
      "description": "The DataStore name.",
      "nullable": true
    },
    "scope": {
      "type": "string",
      "description": "The scope of the key in DataStore.",
      "nullable": true
    },
    "keyTemplate": {
      "type": "string",
      "description": "The key of a DataStore value, with {UserId} replaced by the player's actual ID when fetching values.",
      "nullable": true
    },
    "valuePath": {
      "type": "string",
      "description": "A JSON path to a value if it lives in a JSON object.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "Describes where an attribute value exists in DataStore."
}