Does FusionAuth have a health check endpoint on the API?

[dan]

If I wanted to check the health of a fusionauth installation, what's the best way to do that?

[dan]

The system status API call is the best solution here. It will return a status code when you (or your application load balancer, CDN or other software system) makes a GET request on <faurl>/api/status. It'll either be a 200 if things are all good or a 500 if there are any issues with the system.

It's documented more fully here: https://fusionauth.io/docs/v1/tech/apis/system#system-status

Note that this endpoint is not currently supported by the client libraries, but is just a curl away.

[falk.jaeger]

@dan unfortunately this is not right. If my fusionauth does not boot correctly, for example when the db is not reachable /api/status returns a 308 instead of a 500

[dan]

@falk-jaeger Hmmm.

I don't know how you can get a 308. Is the request going through a proxy or something else?

Here's the list of /api/status return codes (table 8):

https://fusionauth.io/docs/v1/tech/apis/system#retrieve-system-status

If you are getting a different HTTP status code, please submit a bug report with replication steps and your FusionAuth version: https://github.com/fusionauth/fusionauth-issues/issues

[boris.pigin]

I see the redirection to /maintenance-mode-silent-configuration-failed if the futhionauth could start because the fusionauth database not reachable.

[dan]

As of 1.51.1, we now have a dedicated health check API endpoint:

https://fusionauth.io/docs/apis/system#retrieve-system-health has more details