Standard Data Stores

Datastores

https://apis.roblox.com/datastores
Os seguintes endpoints estão disponíveis em caminhos relativos à URL base.

List Data Stores

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

Parâmetros

universeId number
Path
Obrigatório
cursor string
limit number
prefix string

Solicitação

curl
curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores" \

--header "x-api-key: ${API_KEY}" \

--get \

-d "prefix=Player" \

-d "limit=5"

Resposta

200 - OK
Retorna um(a) object
application/json
{

  "datastores": [

    {

      "name": "PlayerInventory",

      "createdTime": "2022-02-18T22:38:59.9244932Z"

    },

    {

      "name": "PlayerExperience",

      "createdTime": "2022-02-18T23:00:10.4773508Z"

    },

    {

      "name": "PlayerWeapons",

      "createdTime": "2022-02-18T23:00:22.3725681Z"

    },

    {

      "name": "PlayerArmor",

      "createdTime": "2022-02-18T22:59:33.8472882Z"

    },

    {

      "name": "PlayerHP",

      "createdTime": "2022-02-18T22:58:47.6904028Z"

    }

  ],

  "nextPageCursor": "..."

}
data array<DataStore>
nextPageCursor string
Opcional

Permissões necessárias

  • Listar armazenamento de dados

Entries

https://apis.roblox.com/datastores
Os seguintes endpoints estão disponíveis em caminhos relativos à URL base.

List Entries

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

Parâmetros

universeId number
Path
Obrigatório
datastoreName string
scope string
allScopes boolean
prefix string
cursor string
limit number

Solicitação

curl
curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries" \

--header "x-api-key: ${API_KEY}" \

--get \

-d "datastoreName=Coins" \

-d "prefix=" \

-d "limit=5"

Resposta

200 - OK
Retorna um(a) object
application/json
{

  "keys": [

    {

      "key": "269323"

    }

  ],

  "nextPageCursor": "eyJ2ZXJzaW9uIjoxLCJjdXJzb3IiOiIzIyJ9"

}
keys array<string>
nextPageCursor string
Opcional

Permissões necessárias

  • Listar chaves de entradas

Get Entry

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

Parâmetros

universeId number
Path
Obrigatório
datastoreName string
entryKey string
scope string

Solicitação

curl
curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry" \

--header "x-api-key: ${API_KEY}" \

--get \

-d "datastoreName=Coins" \

-d "entryKey=269323"

Resposta

200 - OK
Returns the user content of the entry in the body of the response.
Retorna um(a) object
application/json
{

  "content-md5": "zuYxEhwuySMvOi8CitXImw==",

  "roblox-entry-version": "08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01",

  "roblox-entry-created-time": "2022-02-02T23:30:06.5388799+00:00",

  "roblox-entry-version-created-time": "2022-02-02T23:30:06.5388799+00:00",

  "roblox-entry-userids": [ 1, 2, 3 ]

}
roblox-entry-created-time string
last-modified string
roblox-entry-version string
roblox-entry-attributes string
roblox-entry-userids array<number>
content-md5 string

Permissões necessárias

  • Ler Entrada

Set Entry

POST /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

Parâmetros

universeId number
Path
Obrigatório
datastoreName string
entryKey string
matchVersion string
exclusiveCreate boolean
scope string
roblox-entry-attributes string
Header
roblox-entry-userids string
Header
content-md5 string
Header

Solicitação

curl
curl --include --location --request POST "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry?datastoreName=Coins&entryKey=269323" \

--header "x-api-key: ${API_KEY}" \

--header "content-md5: IGPBYI1uC6+AJJxC4r5YBA==" \

--header "content-type: application/json" \

--header "roblox-entry-userids: [269323]" \

--header "roblox-entry-attributes: {}" \

--d "value"

Resposta

200 - OK
Retorna um(a) object: EntryVersion
version string
deleted boolean
contentLength number
createdTime string
objectCreatedTime string

Permissões necessárias

  • Criar Entrada
  • Atualizar entrada

Delete Entry

DELETE /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

Parâmetros

universeId number
Path
Obrigatório
datastoreName string
entryKey string
scope string

Solicitação

curl
curl --include --location --request DELETE "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry" \

--header "x-api-key: ${API_KEY}" \

--get \

-d "datastoreName=Coins" \

-d "entryKey=269323"

Resposta

Permissões necessárias

  • Excluir entrada

Increment Entry

POST /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/increment

Parâmetros

universeId number
Path
Obrigatório
datastoreName string
entryKey string
incrementBy number
scope string
roblox-entry-attributes string
Header
roblox-entry-userids string
Header

Solicitação

curl
curl --include --location --request POST "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/increment" \

--header "x-api-key: ${API_KEY}" \

--header 'content-length: 0' \

--get \

-d "datastoreName=Coins" \

-d "entryKey=269323" \

-d "incrementBy=3"

Resposta

200 - OK
Returns the latest version of the entry after it has been incremented.
Retorna um(a) object
application/json
{

  "content-md5": "K4phWUsfTE2wkCqKOVztkw==",

  "roblox-entry-version": "08D9E6A3F2188CFF.0000000009.08D9E6DF74AC5F42.01",

  "roblox-entry-created-time": "2022-02-02T23:30:06.5388799+00:00",

  "roblox-entry-version-created-time": "2022-02-03T06:36:05.9184962+00:00",

  "roblox-entry-userids": []

}
roblox-entry-created-time string
last-modified string
roblox-entry-version string
roblox-entry-attributes string
roblox-entry-userids array<number>
content-md5 string

Permissões necessárias

  • Criar Entrada
  • Atualizar entrada

Get Entry Version

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/versions/version

Parâmetros

universeId number
Path
Obrigatório
datastoreName string
entryKey string
versionId string
scope string

Solicitação

curl
curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/versions/version" \

--header "x-api-key: ${API_KEY}" \

--get \

-d "datastoreName=Coins" \

-d "entryKey=269323" \

-d "versionId=08D9E6A3F2188CFF.0000000003.08D9E6DE485A7680.01"

Resposta

200 - OK
Retorna um(a) object
application/json
{

  "content-md5": "sTf90fedVsft8zZf6nUg8g==",

  "roblox-entry-version": "08D9E6A3F2188CFF.0000000003.08D9E6DE485A7680.01",

  "roblox-entry-created-time": "2022-02-02T23:30:06.5388799+00:00",

  "roblox-entry-version-created-time": "2022-02-03T06:27:42.0652160+00:00",

  "roblox-entry-attributes": {},

  "roblox-entry-userids": [ 269323 ]

}
roblox-entry-created-time string
last-modified string
roblox-entry-version string

Permissões necessárias

  • Ler versão

Limites

Por chave de API: 100 solicitações a cada 60 segundos por endereço IP

List Entry Versions

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/versions

Parâmetros

universeId number
Path
Obrigatório
datastoreName string
entryKey string
scope string
cursor string
startTime string
endTime string
sortOrder string
limit number

Solicitação

curl
curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/versions" \

--header "x-api-key: ${API_KEY}" \

--get \

-d "datastoreName=Coins" \

-d "entryKey=269323" \

-d "limit=5"

Resposta

200 - OK
Retorna um(a) object: EntryVersion
version string
deleted boolean
contentLength number
createdTime string
objectCreatedTime string

Permissões necessárias

  • Listar versões

Objetos

Os seguintes objetos descrevem payloads que são aceitos ou retornados. Veja cada endpoint para mais informações sobre quando esses objetos são usados.

DataStore

Atributos

name string
Obrigatório
createdTime string

EntryVersion

Atributos

version string
Obrigatório
deleted boolean
Obrigatório
contentLength number
Obrigatório
createdTime string
Obrigatório
objectCreatedTime string
Obrigatório