ManagementAPI

Management Endpoints

Spring Boot applications have built in production ready management endpoints. This page documents the endpoints available within the RCloud Gist Service.

By default the endpoints are exposed on port 13021 and available beneath the /manage path e.g. http://localhost:13021/manage

For additional details see the Spring Boot Actuator documentation.

Security

The management api is ecured using Basic Authentication, for more details see Configuration documentation. The management endpoints are exposed by default on a separate port (13021) on the /manage URL.

Endpoints

A full list of the available endpoints is supplied by accessing the management URL.

curl -X GET  http://localhost:13021/manage

ID	Description	Secure	Enabled
health	Shows application health information when the application is secure, a simple ‘status’ when accessed over an unauthenticated connection or full message details when authenticated. docs	true	true
env	Exposes properties from the application environment, including settings specified in the application configuration. docs	true	true
mappings	Displays a collated list of all request paths. docs	true	true
configprops	Displays a collated list of all internal configuration properties. docs	true	true
trace	Displays trace information (by default the last 100 HTTP requests). docs	true	true
loggers	Shows and modifies the configuration of loggers in the application. docs	true	true
dump	Performs a thread dump. docs	true	true
heapdump	Returns a GZip compressed hprof heap dump file. docs	true	true
refresh	Reloads the configuration file. docs	true	true
restart	Restarts the internal context (doesn't restart the Java process) docs	true	false
pause	Pauses the application docs	true	true
resume	Resumes a paused application docs	true	true
autoconfig	Displays an auto-configuration report showing all auto-configuration candidates and the reason why they ‘were’ or ‘were not’ applied. docs	true	true
metrics	Shows ‘metrics’ information for the current application. docs	true	true
beans	Displays a complete list of all the Spring beans in your application. docs	true	true
auditevents	Exposes audit events information for the current application. docs	true	true
info	Basic information about the service. docs	false	true

Disabling Management Endpoints

It's possible to enable/disable some or all of the management endpoints.

Disable All Management Endpoints

Update the application.yml with the following setting:

endpoints:
  enabled: false

Disabling Specific Endpoints

It's possible to disable/enable specific endpoints. Updating the configuration with the application.yml with the name of the specific endpoint and the enabled flag, for example the following disables the info endpoint:

endpoints:
  info:
    enabled: false