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.

expire #

Sets a timeout (in seconds) on a key. After the timeout has expired, the key is automatically deleted.

[Redis documentation]

Query Syntax #

HTTP #

URL: http://kuzzle:7512/ms/_expire/<_id>
Method: POST
Body:

{
  "seconds": 60
}

Other protocols #

{
  "controller": "ms",
  "action": "expire",
  "_id": "<key>",
  "body": {
    "seconds": 60
  }
}

Arguments #

_id: key to update

Body properties #

seconds: number of seconds before the key expires (integer)

Response #

Returns either 0 (command failed), or 1 (command succeeded).

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