42 lines
1.3 KiB
ReStructuredText
42 lines
1.3 KiB
ReStructuredText
.. _admin_server:
|
|
|
|
Admin Server
|
|
############
|
|
|
|
PostgREST provides an admin server that can be enabled by setting :ref:`admin-server-port` to the port number of your preference.
|
|
|
|
.. _health_check:
|
|
|
|
Health Check
|
|
============
|
|
|
|
You can enable a health check to verify if PostgREST is available for client requests. Also to check the status of its internal state.
|
|
|
|
Two endpoints ``live`` and ``ready`` will then be available.
|
|
|
|
.. important::
|
|
|
|
If you have a machine with multiple network interfaces and multiple PostgREST instances in the same port, you need to specify a unique :ref:`hostname <server-host>`
|
|
in the configuration of each PostgREST instance for the health check to work correctly. Don't use the special values(``!4``, ``*``, etc) in this case because the health check
|
|
could report a false positive.
|
|
|
|
Live
|
|
----
|
|
|
|
The ``live`` endpoint verifies if PostgREST is running on its configured port. A request will return ``200 OK`` if PostgREST is alive or ``503`` otherwise.
|
|
|
|
For instance, to verify if PostgREST is running while the ``admin-server-port`` is set to ``3001``:
|
|
|
|
.. code-block:: bash
|
|
|
|
curl -I "http://localhost:3001/live"
|
|
|
|
.. code-block:: http
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
Ready
|
|
-----
|
|
|
|
In addition, the ``ready`` endpoint checks the state of the :ref:`connection_pool` and the :ref:`schema_cache`. A request will return ``200 OK`` if both are good or ``503`` if not.
|