Retrieve the status of an index rebuild API

On this page

This API is used to retrieve the status of a reindex request. This may be useful to identify if an existing re-index operation has been completed.

Request#

Retrieve the status the Elasticsearch reindex operation

GET/api/system/reindex

OpenAPI Spec

Response Codes

Code	Description
202	A re-index operation is currently in progress.
400	The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401	You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404	A re-index operation is not currently in progress. No response body will be returned.
500	There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.
503	The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

API documentation for the FusionAuth Rebuild the Elasticsearch index API.

Learn about the APIs for retrieving and updating integrations.

API documentation for the FusionAuth Export System Logs API.

Learn about the APIs for retrieving and updating the system configuration.