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.

object #

Inspects the low-level properties of a key.

[Redis documentation]


Query Syntax #

HTTP #

Copied to clipboard!
URL: http://kuzzle:7512/ms/_object/<_id>?subcommand=[refcount|encoding|idletime]
Method: GET

Other protocols #

Copied to clipboard!
{
  "controller": "ms",
  "action": "object",
  "_id": "<key>",
  "subcommand": "[refcount|encoding|idletime]"
}

Argument #

  • _id: key identifier
  • subcommand: the object property to inspect. Allowed values: refcount, encoding, idletime

Response #

If subcommand is set to refcount or idletime, then an integer is returned:

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

If subcommand is set to encoding, then a string is returned:

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