8.2. Using a Specialized Endpoint for the State of the Postgres ProGate Management Service #
The state of Postgres ProGate management service is returned in response to requesting a specialized endpoint. If the management service is installed at the progate.example.com address, the endpoint is located at the path https://progate.example.com/api/v1/health/ready.
In response to the HTTP GET request at this path, the management service returns the current status:
okindicates that the management service is running, available at the specified path, and ready for operation.In case of a management service error, the response code is
"code": "SERVER_ERROR", and additional parameters are returned that carry diagnostics information.In case of an incorrect configuration of the web server, the response with an
HTTP 502status code is returned. This response indicates broken connectivity between the web server and the Postgres ProGate management service.