Ordered Data Stores (Beta)
OrderedDataStores
https://apis.roblox.com/ordered-data-stores
List
GET /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries
Parameters
universeId string
Path
Required
orderedDataStore string
Path
Required
scope string
Path
Required
max_page_size number
page_token string
order_by string
filter string
Request
curl
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries' \
--header 'x-api-key: <insert-api-key>'Response
Other Status Codes
Create
POST /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries
Parameters
universeId string
Path
Required
orderedDataStore string
Path
Required
scope string
Path
Required
id string
Required
CreateEntryRequest CreateEntryRequest
Body
Required
Request
curl
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries?id=<id>' \
--header 'x-api-key: <insert-api-key>' \
--header 'Content-Type: application/json' \
--data '{
"value": <long>
}'Response
Other Status Codes
Get
GET /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}
Parameters
universeId string
Path
Required
orderedDataStore string
Path
Required
scope string
Path
Required
entry string
Path
Required
Request
curl
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \
--header 'x-api-key: <insert-api-key>'Response
Other Status Codes
Delete
DELETE /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}
Parameters
universeId string
Path
Required
orderedDataStore string
Path
Required
scope string
Path
Required
entry string
Path
Required
Request
curl
curl --location --request DELETE 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \
--header 'x-api-key: <insert-api-key>'Response
Other Status Codes
Update
PATCH /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}
Parameters
universeIdId string
Path
Required
orderedDataStore string
Path
Required
scope string
Path
Required
entry string
Path
Required
UpdateEntryRequest UpdateEntryRequest
Body
Required
allow_missing boolean
Request
curl
curl --location --request PATCH 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \
--header 'x-api-key: <insert-api-key>' \
--header 'Content-Type: application/json' \
--data '{
"value": <long>
}'Response
Other Status Codes
Increment
POST /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}:increment
Parameters
universeId string
Path
Required
orderedDataStore string
Path
Required
scope string
Path
Required
entry string
Path
Required
incrementEntryRequest IncrementEntryRequest
Body
Required
Request
curl
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>:increment' \
--header 'x-api-key: <insert-api-key>' \
--header 'Content-Type: application/json' \
--data '{
"amount": <long>
}'Response
Other Status Codes
Objects
The following objects describe payloads that are accepted or returned. See each individual endpoint for more information on when these objects are used.Entry
Attributes
path string
Required
id string
Required
value number
Required
IncrementEntryRequest
Attributes
amount number
Required
UpdateEntryRequest
Attributes
value number
Required
CreateEntryRequest
Attributes
value number
Required