Management endpoints¶
EntryStore 6.x offers a set of management endpoints under {base}/management/. Except for the basic status, all of them are restricted to admins, i.e. the admin user and members of the _admins group. Guests are answered with 401 and other users with 403.
| Endpoint | Methods | Description |
|---|---|---|
/management/status |
GET | Basic status, accessible to everyone, see Status |
/management/status/extended |
GET | Extended status and effective configuration, see Status |
/management/solr |
POST | Rebuilding the Solr index, see Search |
/management/metrics |
GET | Request and JVM metrics, see Performance metrics |
/management/loggers |
GET, POST | Inspecting and changing log levels at runtime, see Logging |
/management/caches |
GET, DELETE | Listing and clearing internal caches |
/management/env |
GET | Effective configuration properties; credentials are masked |
/management/httpexchanges |
GET | The last 100 HTTP requests and responses, without cookies and Authorization headers |
/management/shutdown |
POST | Shutting down EntryStore, see Shutdown |
Except for status and solr, these are Spring Boot Actuator endpoints and follow its request and response formats. There is no overview at /management itself.
If CSRF protection is enabled, POST and DELETE requests that are authenticated with the session cookie must send the X-XSRF-TOKEN header.
Caches¶
GET /management/caches lists the caches of the REST layer, such as rate limiter counters, SSO login requests and pending sign-up and password reset confirmations (signup-tokens). DELETE /management/caches/{name} clears one cache and DELETE /management/caches clears all of them. Clearing signup-tokens invalidates all pending sign-up and password reset confirmations.
EntryStore 5.x
5.x offers /management/status, /management/solr, /management/metrics, /management/logging (PUT) and /management/shutdown, with different formats and permissions as described on the respective pages. The other endpoints do not exist in 5.x.