POST /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}:increment — datastores-api/ordered-v1

Increments the value of the key by the provided amount and returns the updated entry.

Known issue: Entry values can increment past the valid range and this may persist in the backend. Returned values will clamp to the valid range.

Endpoint

Method: POST

Path: /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}:increment

Servers:

https://apis.roblox.com/ordered-data-stores

Parameters

Name	Location	Required	Description
universeId	path	true	The identifier of the experience with ordered data stores that you want to access. You can find your experience's universe ID on Creator Hub.
orderedDataStore	path	true	The name of the ordered data store.
scope	path	true	The name of the data store scope. See Scopes.
entry	path	true	The entry ID.

[
  {
    "name": "universeId",
    "in": "path",
    "description": "The identifier of the experience with ordered data stores that you want to access. You can find your experience's universe ID on Creator Hub.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "orderedDataStore",
    "in": "path",
    "description": "The name of the ordered data store.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "scope",
    "in": "path",
    "description": "The name of the data store scope. See [Scopes](/cloud/guides/data-stores/request-handling.md#scopes).",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "entry",
    "in": "path",
    "description": "The entry ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/IncrementEntryRequest"
      }
    }
  },
  "required": true
}

Responses

Status	Description
200	OK
400	Bad Request: invalid orderedDataStore, scope or entry name or encoding.
403	Forbidden: studio access to APIs is not allowed, incorrect API key or scope.
404	Not found.
429	Too Many Requests.

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Entry"
        }
      }
    }
  },
  "400": {
    "description": "Bad Request: invalid orderedDataStore, scope or entry name or encoding."
  },
  "403": {
    "description": "Forbidden: studio access to APIs is not allowed, incorrect API key or scope."
  },
  "404": {
    "description": "Not found."
  },
  "429": {
    "description": "Too Many Requests."
  }
}

Authentication

{
  "security": [
    {
      "roblox-api-key": [
        "universe.ordered-data-store.scope.entry:write"
      ]
    }
  ],
  "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"
    }
  }
}

Complete Operation Definition

{
  "tags": [
    "OrderedDataStores"
  ],
  "description": "Increments the value of the key by the provided amount and returns the updated entry.\n\nKnown issue: Entry values can increment past the valid range and this may persist in the backend. Returned values will clamp to the valid range.",
  "operationId": "OrderedDataStores_IncrementEntry",
  "x-roblox-cloud-api-operation-name": "Increment",
  "x-roblox-stability": "BETA",
  "parameters": [
    {
      "name": "universeId",
      "in": "path",
      "description": "The identifier of the experience with ordered data stores that you want to access. You can find your experience's universe ID on Creator Hub.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "orderedDataStore",
      "in": "path",
      "description": "The name of the ordered data store.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "scope",
      "in": "path",
      "description": "The name of the data store scope. See [Scopes](/cloud/guides/data-stores/request-handling.md#scopes).",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "entry",
      "in": "path",
      "description": "The entry ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/IncrementEntryRequest"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Entry"
          }
        }
      }
    },
    "400": {
      "description": "Bad Request: invalid orderedDataStore, scope or entry name or encoding."
    },
    "403": {
      "description": "Forbidden: studio access to APIs is not allowed, incorrect API key or scope."
    },
    "404": {
      "description": "Not found."
    },
    "429": {
      "description": "Too Many Requests."
    }
  },
  "security": [
    {
      "roblox-api-key": [
        "universe.ordered-data-store.scope.entry:write"
      ]
    }
  ],
  "x-roblox-scopes": [
    {
      "name": "universe.ordered-data-store.scope.entry:write"
    }
  ],
  "x-roblox-cloud-api-operation-code-samples": [
    {
      "language": "curl",
      "script": "curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>:increment' \\\n--header 'x-api-key: <insert-api-key>' \\\n--header 'Content-Type: application/json' \\\n--data '{ \n    \"amount\": <long> \n}'\n"
    }
  ],
  "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}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}:increment",
      "httpMethod": "POST"
    }
  ]
}