Core
API v1.x
1

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

incrbyfloat #

Increments the number stored at key by the provided float value. If the key does not exist, it is set to 0 before performing the operation.

[Redis documentation]


Query Syntax #

HTTP #

URL: http://kuzzle:7512/ms/_incrbyfloat/<_id>
Method: POST
Body:
{
  "value": <increment float value>
}

Other protocols #

{
  "controller": "ms",
  "action": "incrbyfloat",
  "_id": "<key>",
  "body": {
    "value": <increment float value>
  }
}

Arguments #

  • _id: key identifier

Body properties #

  • value: the float value to add to the key value

Response #

Returns the incremented float value.

{
  "requestId": "<unique request identifier>",
  "status": 200,
  "error": null,
  "controller": "ms",
  "action": "incrbyfloat",
  "collection": null,
  "index": null,
  "result": "3.1415"
}