refresh

Available since 2.1.0

Forces an immediate reindexation of the provided security collection.

The available security collections are: users, profiles, roles.

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.

Forcing immediate refreshes comes with performance costs, and should only performed when absolutely necessary.


Query Syntax

HTTP

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

Other protocols

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

Arguments

  • collection: collection name to refresh

Response

Returns a response with status 200 if the refresh succeeds.

Copied to clipboard!
{
  "status": 200,
  "error": null,
  "collection": "<collection>",
  "controller": "security",
  "action": "refresh",
  "requestId": "<unique request identifier>",
  "result": null
}

Possible errors