Management endpoints

nevisAuth implements a liveness endpoint that can, for example, be used to integrate with Kubernetes. Check the Kubernetes documentation for more information on how to configure the liveness probes.

Liveness Endpoint

The liveness endpoint informs whether the server is up or not. The server might be up and running but it might not be ready to properly handle requests (for instance because of a misconfiguration). The liveness endpoint is accessible using the management port which is configured using the management.server.port property as described in the Server configuration properties. Currently, only HTTP is supported.

The following table describes the HTTP API of the liveness endpoint:

Topic	Description
Default URL	https://hostname:8997/nevisauth/liveness
Request HTTP Method	GET
Response Content-Type	application/json;charset=utf-8
Response Body if nevisAuth is Alive	{ "status" : "UP" }
HTTP Status Code if nevisAuth is Alive	200 (OK)