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.

hgetall #

Returns all fields and values of a hash.

[Redis documentation]


Query Syntax #

HTTP #

URL: http://kuzzle:7512/ms/_hgetall/<_id>
Method: GET

Other protocols #

{
  "controller": "ms",
  "action": "hgetall",
  "_id": "<key>"
}

Arguments #

  • _id: hash key identifier

Response #

Returns the requested hash content as a field: value object.

{
  "requestId": "<unique request identifier>",
  "status": 200,
  "error": null,
  "controller": "ms",
  "action": "hgetall",
  "collection": null,
  "index": null,
  "result": {
    "field1": "value",
    "field2": "value",
    "...": "..."
  }
}