GET /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id} — openapi

Get Data Store Entry

Gets the specified entry.

To get the entry at a specific revision, add @<revisionId> to the end of the path.

For example, to get my-entry at the revision ID 08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01, use the path /cloud/v2/universes/1234/data-stores/5678/entries/my-entry@08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01.

If your entry ID contains one or more @ characters, and you want to get the latest version rather than at any specific revision, append the special revision ID @latest to the end of the path. Otherwise, the segment of the entry ID after the last @ will be interpreted as a revision ID.

For example, to get the latest revision of my-entry, use the path /cloud/v2/universes/1234/data-stores/5678/entries/my@entry@latest.

To get the entry that was current at a specific time, add @latest:<timestamp> to the end of the path, where <timestamp> is RFC-3339 formatted. The given timestamp must be after the Unix epoch (1/1/1970) and not more than ten minutes in the future.

For example, to get the revision of my-entry that was current on 12/2/2024 at 06:00 UTC, use the path /cloud/v2/universes/1234/data-stores/5678/entries/my-entry@latest:2024-12-02T06:00:00Z.

Endpoint

Method: GET

Path: /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id}

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
universe_id	path	true	The universe ID.
data_store_id	path	true	The data-store ID.
scope_id	path	true	The scope ID.
entry_id	path	true	The entry ID.

[
  {
    "name": "universe_id",
    "in": "path",
    "description": "The universe ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "data_store_id",
    "in": "path",
    "description": "The data-store ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "scope_id",
    "in": "path",
    "description": "The scope ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "entry_id",
    "in": "path",
    "description": "The entry ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Responses

Status	Description
200	OK

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

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

DataStoreEntry

Complete Operation Definition

{
  "tags": [
    "Data and memory stores"
  ],
  "summary": "Get Data Store Entry",
  "description": "Gets the specified entry.\n\nTo get the entry at a specific revision, add `@<revisionId>` to the end of\nthe path.\n\nFor example, to get `my-entry` at the revision ID\n`08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01`, use the path\n`/cloud/v2/universes/1234/data-stores/5678/entries/my-entry@08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01`.\n\nIf your entry ID contains one or more `@` characters, and you want to get\nthe latest version rather than at any specific revision, append the special\nrevision ID `@latest` to the end of the path. Otherwise, the segment of the\nentry ID after the last `@` will be interpreted as a revision ID.\n\nFor example, to get the latest revision of `my-entry`, use the path\n`/cloud/v2/universes/1234/data-stores/5678/entries/my@entry@latest`.\n\nTo get the entry that was current at a specific time, add\n`@latest:<timestamp>` to the end of the path, where `<timestamp>` is\nRFC-3339 formatted. The given timestamp must be after\nthe Unix epoch (1/1/1970) and not more than ten minutes in the future.\n\nFor example, to get the revision of `my-entry` that was current on\n12/2/2024 at 06:00 UTC, use the path\n`/cloud/v2/universes/1234/data-stores/5678/entries/my-entry@latest:2024-12-02T06:00:00Z`.",
  "operationId": "Cloud_GetDataStoreEntry__Using_Universes_DataStores_Scopes",
  "parameters": [
    {
      "name": "universe_id",
      "in": "path",
      "description": "The universe ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "data_store_id",
      "in": "path",
      "description": "The data-store ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "scope_id",
      "in": "path",
      "description": "The scope ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "entry_id",
      "in": "path",
      "description": "The entry ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/DataStoreEntry"
          }
        }
      }
    }
  },
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": true
  },
  "x-roblox-rate-limits": {
    "description": "Data stores requests are subject to additional throttling limits described in the [Open Cloud guide for data stores](https://create.roblox.com/docs/cloud/guides/data-stores/throttling).",
    "perApiKeyOwner": {
      "period": "MINUTE",
      "maxInPeriod": 1000000
    }
  },
  "x-roblox-scopes": [
    {
      "name": "universe-datastores.objects:read"
    }
  ],
  "x-roblox-docs": {
    "category": "Data and memory stores",
    "methodProperties": {
      "scopes": [
        "universe-datastores.objects:read"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/DataStoreEntry",
      "name": "DataStoreEntry"
    }
  },
  "x-roblox-stability": "STABLE",
  "security": [
    {
      "roblox-api-key": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/storage#Cloud_GetDataStoreEntry__Using_Universes_DataStores_Scopes"
  }
}