CAcardinalapps
Indexing

🛡️ Get the current state of the indexing service.

Returns a snapshot of the indexing state at this current moment. Use this endpoint for one-time checks. For real-time updates, use the /events/subscribe endpoint instead.

<!-- Leave this line empty -->

<br /><hr /><h3>🛡️ Requires Capabilities: <code>Indexing.Read</code></h3>

get/api/v1/index/state

Request

Response

The returned object will contain the state of the indexing service. Possible states are: idle indexing paused

<!-- Leave this line empty -->
unknown required

Example response

{
  "state": "idle"
}

Changes

No recorded changes to this operation across all 68 revisions of this API.