> For the complete documentation index, see [llms.txt](https://fusionauth.io/docs/llms.txt)

# Retrieve System Status

API documentation for the FusionAuth Retrieve System Status API.

# 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](https://fusionauth.io/docs/apis/system/retrieve-system-health.md).

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](https://fusionauth.io/docs/reference/configuration.md) for more info.

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

note

FusionAuth also supports a system status check [using Prometheus](https://fusionauth.io/docs/operate/monitor/prometheus.md).

## Request

[!API Key Authentication](https://fusionauth.io/docs/apis/authentication.md#api-key-authentication)[!Basic Authentication using an API Key](https://fusionauth.io/docs/apis/authentication.md#basic-authentication-using-an-api-key)[!Localhost Authentication Bypass](https://fusionauth.io/docs/apis/authentication.md#localhost-authentication-bypass)[!No Authentication Required](https://fusionauth.io/docs/apis/authentication.md#no-authentication-required)

Return the system status

GET/api/status

OpenAPI Spec

## 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.

```json
{
  "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`.

```json
{
  "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*

| Code | Description |
| --- | --- |
| 200 | FusionAuth is functioning properly |
| 452 | FusionAuth is failing to make a JDBC connection to the configured database. |
| 453 | The FusionAuth database connection pool connectivity is below the healthy threshold. This means requests are waiting too long to obtain a connection to the database. Additional information may be available in the JSON response which is retrieved when using an API key. |
| 454 | The FusionAuth database connection pool connectivity is below the healthy threshold. Additional information may be available in the JSON response which is retrieved when using an API key.  
  
As of version `1.51.1` this status code will no longer be returned based upon the connectivity health check. In practice you only need to monitor for `452` to ensure FusionAuth is able to connect to the database. |
| 460 | FusionAuth is using Elasticsearch and the search service is reporting an unhealthy cluster status. In a cluster with 2+ nodes, this means the cluster status is being reported as `yellow` or `red`. In a single-node Elasticsearch configuration this means the cluster status is `red.`  
  
As of version `1.51.1` this status code will no longer be returned based upon the Elasticsearch health check. If you are using an external Elasticsearch or OpenSearch service, you will want to monitor that separately from FusionAuth. |
| 500 | FusionAuth is not functioning properly. This could indicate that the database connectivity failed or one or more services within FusionAuth failed. Consult the FusionAuth [Troubleshooting](https://fusionauth.io/docs/operate/troubleshooting.md) to learn more about the failure or contact FusionAuth support for assistance. |