getAutoRefresh

Returns the current autoRefresh status for the given index.

The autoRefresh flag, when set to true, forces Kuzzle to perform a refresh request immediately after each change in the storage, causing documents to be immediately visible in a search.


Query Syntax

HTTP

Copied to clipboard!
URL: http://kuzzle:7512/<index>/_autoRefresh
Method: GET

Other protocols

Copied to clipboard!
{
  "index": "<index>",
  "controller": "index",
  "action": "getAutoRefresh"
}

Arguments

  • index: index name

Response

Returns a boolean giving the current value of the autoRefresh flag.

Copied to clipboard!
{
  "status": 200,
  "error": null,
  "requestId": "<unique request identifier>",
  "index": "<index>",
  "controller": "index",
  "action": "getAutoRefresh",
  "result":  false
}

Possible errors