refresh

Forces an immediate reindexation of the provided index.

When writing or deleting documents in Kuzzle, the changes need to be indexed before being reflected in the search results. By default, this operation can take up to 1 second.

Note: forcing immediate refreshes comes with performance costs, and should only performed when absolutely necessary.


Query Syntax

HTTP

Copied to clipboard!
URL: http://kuzzle:7512/<index>/_refresh
Method: POST

Other protocols

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

Arguments

  • index: index name to refresh

Response

Returns an object detailing the status of the forced refresh.

Copied to clipboard!
{
  "status": 200,
  "error": null,
  "index": "<index>",
  "controller": "index",
  "action": "refresh",
  "requestId": "<unique request identifier>",
  "result": {
    "_shards": {
        "failed": 0,
        "succressful": 5,
        "total": 10
    }
  }
}

Possible errors