JAMES-2526 Add health check endpoint documentation
Project: http://git-wip-us.apache.org/repos/asf/james-project/repo Commit: http://git-wip-us.apache.org/repos/asf/james-project/commit/3b648e90 Tree: http://git-wip-us.apache.org/repos/asf/james-project/tree/3b648e90 Diff: http://git-wip-us.apache.org/repos/asf/james-project/diff/3b648e90 Branch: refs/heads/master Commit: 3b648e90fd53434731df4425ede14f9d46ca9549 Parents: 2655763 Author: Antoine Duprat <adup...@linagora.com> Authored: Thu Aug 23 11:35:16 2018 +0200 Committer: Antoine Duprat <adup...@linagora.com> Committed: Mon Aug 27 14:18:07 2018 +0200 ---------------------------------------------------------------------- src/site/markdown/server/manage-webadmin.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/james-project/blob/3b648e90/src/site/markdown/server/manage-webadmin.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/server/manage-webadmin.md b/src/site/markdown/server/manage-webadmin.md index 8dd14c4..2e869c2 100644 --- a/src/site/markdown/server/manage-webadmin.md +++ b/src/site/markdown/server/manage-webadmin.md @@ -6,6 +6,8 @@ The web administration supports for now the CRUD operations on the domains, the **WARNING**: This API allow authentication only via the use of JWT. If not configured with JWT, an administrator should ensure an attacker can not use this API. +By the way, some endpoints are not filtered by authentication. Those endpoints are not related to data stored in James, for example: Swagger documentation & James health checks. + Please also note **webadmin** is only enabled with **Guice**. You can not use it when using James with **Spring**, as the required injections are not implemented. In case of any error, the system will return an error message which is json format like this: @@ -24,6 +26,7 @@ as exposed above). To avoid information duplication, this is ommited on endpoint ## Navigation menu + - [HealthCheck](#HealthCheck) - [Administrating domains](#Administrating_domains) - [Administrating users](#Administrating_users) - [Administrating user mailboxes](#Administrating_user_mailboxes) @@ -40,6 +43,21 @@ as exposed above). To avoid information duplication, this is ommited on endpoint - [Administrating Sieve quotas](#Administrating_Sieve_quotas) - [Task management](#Task_management) +## HealthCheck + +This endpoint is simple for now and is just returning the http status code corresponding to the state of checks (see below). +The user has to check in the logs in order to have more information about failing checks. + +``` +curl -XGET http://ip:port/healthcheck +``` + +Response codes: + + - 200: All checks have answered with a Healthy status + - 500: At least one check have answered with a Unhealthy or Degraded status + + ## Administrating domains - [Create a domain](#Create_a_domain) --------------------------------------------------------------------- To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org For additional commands, e-mail: server-dev-h...@james.apache.org
