Core
API v2.x
2

# pexpireat

Sets an expiration timestamp on a key. After the timestamp has been reached, the key will automatically be deleted.

The timestamp parameter accepts an Epoch time value, in milliseconds.

[Redis documentation]


# Argument

  • _id: key identifier

# Query Syntax

# HTTP

Copied to clipboard!
URL: http://kuzzle:7512/ms/_pexpireat/<_id>
Method: POST
Body:
Copied to clipboard!
{
  "timestamp": 1538640821799
}

# Other protocols

Copied to clipboard!
{
  "controller": "ms",
  "action": "pexpireat",
  "_id": "<key>",
  "body": {
    "timestamp": 1538640821799
  }
}

# Argument

  • _id: key identifier

# Body properties

  • timestamp: the key expiration timestamp, using the Epoch-millis format

# Response

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

Copied to clipboard!
{
  "requestId": "<unique request identifier>",
  "status": 200,
  "error": null,
  "controller": "ms",
  "action": "pexpireat",
  "collection": null,
  "index": null,
  "result": 1
}