Usage examples
Available endpoints
Web-UI related endpoints
| Endpoint | Description |
|---|---|
/ | Banner page for the WEB-UI. |
/login | Login / Logout page for Interactive login at the Web-UI. |
/swagger-ui/index.html | OpenApi Documentation page. |
info
Access to /swagger-ui/index.html requires authentication with the ADMIN user role.
API related endpoints
| Endpoint | Description |
|---|---|
/status | Show the Service Status. |
/api/* | Api related endpoints. For more information see the API-Documentation. Required user role API for access. |
info
Access to /api/* requires authentication with the API user role.
Actuator endpoints
The application provides some actuator endpoints that can be used for monitoring purposes.
For more information see the API-Documentation. Required user role METRICS.
| Endpoint | Description |
|---|---|
/actuator | Actuator root endpoint. |
/actuator/health | Actuator endpoint 'health'. |
/actuator/info | Actuator endpoint 'info'. |
actuator/metrics | Actuator endpoint 'metrics'. |
info
Access to /actuator requires authentication with the METRICS user role.
Authentication
Different authorisation roles are required to use the application and its API endpoints.
For description See Configuring the authorisations