For AI agents: The complete documentation index is available at /docs/llms.txt. A markdown version of this page is available at /docs/apis/system/retrieve-system-health.md.

Retrieve System Health API

Edit on GitHub
View Markdown
On this page
Available since 1.51.1

The Health API is used to monitor the health of the FusionAuth service. This endpoint is specifically intended for use by a load balancer to understand when FusionAUth is available, live and ready for requests. Prefer this endpoint to the Status API when using it for a load balancer or a Kubernetes readiness check.

This API does not require an API key.

Request#

No Authentication Required
Return the system health
GET/api/health
OpenAPI Spec

Response#

This API does not return a JSON response body.

Response Codes

CodeDescription
200FusionAuth is functioning properly and can accept requests.
500FusionAuth is not functioning properly. This will generally indicate that FusionAuth is not able to communicate with the database or complete I/O operations.

Related

APIs

Export System Logs API

API documentation for the FusionAuth Export System Logs API.

fusionauth apirest apihttp api
APIs

System API

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

fusionauth apirest apihttp api
APIs

Rebuild the Elasticsearch index API

API documentation for the FusionAuth Rebuild the Elasticsearch index API.

fusionauth apirest apihttp api
APIs

Retrieve System Metrics Using Prometheus API

API documentation for the FusionAuth Retrieve System Metrics Using Prometheus API.

fusionauth apirest apihttp api