You can enable a health check to verify if PostgREST is available for client requests. Also to check the status of its internal state.
To do this, set the configuration variable admin-server-port to the port number of your preference. Two endpoints
ready will then be available.
live endpoint verifies if PostgREST is running on its configured port. A request will return
200 OK if PostgREST is alive or
ready endpoint also checks the state of both the Database Connection and the Schema Cache. A request will return
200 OK if it is ready or
503 if not.
For instance, to verify if PostgREST is running at
localhost:3000 while the
admin-server-port is set to
curl -I "http://localhost:3001/live"
HTTP/1.1 200 OK
If you have a machine with multiple network interfaces and multiple PostgREST instances in the same port, you need to specify a unique hostname in the configuration of each PostgREST instance for the health check to work correctly. Don’t use the special values(
*, etc) in this case because the health check could report a false positive.