Retrieve System Status

The Status API is used to retrieve the current status and metrics for FusionAuth. This is useful for monitoring. For health checks, prefer the Health API.

By default, this API requires authentication to return full results. If you prefer to allow unauthenticated access to this endpoint from local scrapers, you may set fusionauth-app.local-metrics.enabled=true. See the configuration reference for more info.

If you call this API without an API key, you will receive a status response only.

Request#

Return the system status

Response#

This JSON response body varies based on whether you:

• provide an API key
• do not provide an API key
• configure local bypass

When no API key is used and local bypass is not enabled, the response will only include the status property.

{
  "status": "ok"
}

When retrieved with an API key or if local bypass is enabled, the JSON response from the Status API is complex and subject to change. The only exception is the version key.

The version key will not change and will be returned as below. As a reminder, an API key is required to obtain this value unless explicitly allowed from localhost.

{
  "version": "1.59.0"
}

The specific contents of the JSON body are not documented here. If you choose to use this API for monitoring purposes you should primarily use the response code to indicate server health. If you receive a 200 you may consider FusionAuth in a healthy state. The response body is intended for use by FusionAuth support.

Response Codes