Management Endpoints
The management feature described in this section are experimental and can change in future releases.
nevisFIDO provides two management endpoints that you can use to detect the current state of the instance. These can for example be used to integrate with Kubernetes container probes.
Liveness Endpoint
The liveness endpoint informs whether the server is up and running. Note that the server can be up and running but not ready to propertly handle requests (for instance because of a misconfiguration). The endpoint is accessible via the management port. You configure this port with 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:
| Description | Example |
|---|---|
| Default URL | http://hostname:9089/nevisfido/liveness |
| Request HTTP method | GET |
| Response content-type | application/vnd.spring-boot.actuator.v2+json |
| Response body if nevisFIDO is alive | { "status" : "UP" } |
| HTTP status code if nevisFIDO is alive | 200 (OK) |
Readiness Endpoint
The readiness endpoint informs whether the server is ready to handle requests. The endpoint is accessible via the management port. You configure this port with 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 readiness endpoint:
| Description | Example |
|---|---|
| Default URL | http://hostname:9089/nevisfido/health |
| Request HTTP method | GET |
| Response content-type | application/vnd.spring-boot.actuator.v2+json |
| Response body if nevisFIDO is ready | { "status" : "UP" } |
| HTTP status code if nevisFIDO is ready | 200 (OK) |
| Response body if nevisFIDO is not ready | { "status" : "DOWN" } |
| HTTP status code if nevisFIDO is not ready | 503 (Service Unavailable) |