### Info Source: https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html Displays arbitrary application information, typically including build details like version, git commit, and build time. This is useful for quick checks of application metadata. ```APIDOC ## GET /actuator/info ### Description Displays arbitrary application information. ### Method GET ### Endpoint /actuator/info ### Response #### Success Response (200) - The response body is a JSON object containing arbitrary application information, typically including build details. ``` -------------------------------- ### Environment Source: https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html Displays the current environment properties, including system properties, environment variables, and application properties. This provides a comprehensive view of the application's runtime configuration. ```APIDOC ## GET /actuator/env ### Description Displays the current environment properties of the application. ### Method GET ### Endpoint /actuator/env ### Response #### Success Response (200) - **activeProfiles** (list) - A list of active Spring profiles. - **propertySources** (list) - A list of property sources contributing to the environment. - **name** (string) - The name of the property source. - **properties** (object) - Key-value pairs of properties from this source. ``` -------------------------------- ### Configuration Properties Source: https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html Exposes all the configuration properties available in the application, including those from `application.properties` and externalized configuration. This is invaluable for understanding and debugging application settings. ```APIDOC ## GET /actuator/configprops ### Description Exposes all the configuration properties available in the application. ### Method GET ### Endpoint /actuator/configprops ### Response #### Success Response (200) - **contexts** (object) - An object where keys are context IDs and values are property groups. - **beans** (object) - An object where keys are bean names and values are property details. - **properties** (object) - An object containing configuration properties for a specific bean. - **propertyName** (string) - The name of the configuration property. - **value** (any) - The current value of the property. - **defaultValue** (any) - The default value of the property. - **source** (string) - The source of the property value (e.g., file name). ``` -------------------------------- ### Log File Source: https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html Returns the contents of the application's log file. This is useful for real-time monitoring of application logs. ```APIDOC ## GET /actuator/logfile ### Description Returns the contents of the application's log file. ### Method GET ### Endpoint /actuator/logfile ### Response #### Success Response (200) - The response body contains the content of the application's log file. ``` -------------------------------- ### Caches Source: https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html Provides details about the available caches in the application, including their names and statistics. This endpoint is useful for monitoring cache performance and usage. ```APIDOC ## GET /actuator/caches ### Description Provides details about the available caches in the application. ### Method GET ### Endpoint /actuator/caches ### Response #### Success Response (200) - **caches** (list) - A list of available cache objects. - **name** (string) - The name of the cache. - **type** (string) - The type of cache implementation. - **target** (string) - The underlying cache manager. ``` -------------------------------- ### Beans Source: https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html Exposes a list of all Spring beans in the application context, along with their aliases, scope, and resource. This is helpful for understanding the application's internal structure. ```APIDOC ## GET /actuator/beans ### Description Exposes a list of all Spring beans in the application context. ### Method GET ### Endpoint /actuator/beans ### Response #### Success Response (200) - **contexts** (object) - An object where keys are context IDs and values are bean lists. - **beans** (list) - A list of beans within a specific context. - **bean** (string) - The name of the bean. - **aliases** (list) - A list of aliases for the bean. - **scope** (string) - The scope of the bean (e.g., 'singleton', 'prototype'). - **type** (string) - The fully qualified class name of the bean. - **resource** (string) - The resource location of the bean definition. ``` -------------------------------- ### Metrics Source: https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html Provides access to various application metrics, such as JVM memory usage, CPU utilization, HTTP request counts, and custom application metrics. This endpoint is crucial for performance monitoring and analysis. ```APIDOC ## GET /actuator/metrics ### Description Provides access to various application metrics. ### Method GET ### Endpoint /actuator/metrics ### Response #### Success Response (200) - **names** (list) - A list of available metric names. ## GET /actuator/metrics/{name} ### Description Retrieves the value(s) for a specific metric. ### Method GET ### Endpoint /actuator/metrics/{name} ### Parameters #### Path Parameters - **name** (string) - Required - The name of the metric to retrieve. #### Query Parameters - **tag** (string) - Optional - Filter metrics by tags (e.g., 'http.status=200'). ### Response #### Success Response (200) - **name** (string) - The name of the metric. - **description** (string) - A description of the metric. - **baseUnit** (string) - The base unit of the metric (e.g., 'bytes', 'seconds'). - **measurements** (list) - A list of measurements for the metric. - **statistic** (string) - The statistic type (e.g., 'TOTAL', 'COUNT', 'MAX'). - **value** (number) - The value of the measurement. ``` -------------------------------- ### Flyway Source: https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html Provides information about Flyway database migrations, including applied scripts and their status. This is useful for managing and verifying database schema versions. ```APIDOC ## GET /actuator/flyway ### Description Provides information about Flyway database migrations. ### Method GET ### Endpoint /actuator/flyway ### Response #### Success Response (200) - **flywayBeans** (list) - A list of Flyway beans configured in the application. - **name** (string) - The name of the Flyway bean. - **schemas** (list) - A list of schemas managed by this Flyway instance. - **migrations** (list) - A list of applied migrations. - **version** (string) - The version of the migration script. - **description** (string) - The description of the migration. - **type** (string) - The type of migration (e.g., 'SQL', 'JDBC'). - **script** (string) - The name of the migration script. - **checksum** (integer) - The checksum of the migration script. - **installedRank** (integer) - The rank of the migration in the applied order. - **installedOn** (string) - The timestamp when the migration was installed. - **installedBy** (string) - The user who installed the migration. ``` -------------------------------- ### Mappings Source: https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html Exposes a list of all the request mappings (endpoints) configured in the application, including their HTTP methods, patterns, and handler details. This is useful for understanding the application's API surface. ```APIDOC ## GET /actuator/mappings ### Description Exposes a list of all request mappings configured in the application. ### Method GET ### Endpoint /actuator/mappings ### Response #### Success Response (200) - **dispatcherServlets** (object) - An object where keys are dispatcher servlet names and values are their mappings. - **dispatcherServletName** (object) - Mappings handled by a specific dispatcher servlet. - **GET** (list) - List of mappings for GET requests. - **POST** (list) - List of mappings for POST requests. - ... (other HTTP methods) - **pattern** (string) - The URL pattern for the mapping. - **handler** (string) - The handler method or controller associated with the mapping. - **produces** (string) - The media types the mapping produces. - **consumes** (string) - The media types the mapping consumes. ``` -------------------------------- ### Liquibase Source: https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html Provides information about Liquibase database schema changes, including applied contexts and changelogs. This is useful for managing and verifying database schema versions. ```APIDOC ## GET /actuator/liquibase ### Description Provides information about Liquibase database schema changes. ### Method GET ### Endpoint /actuator/liquibase ### Response #### Success Response (200) - **liquibaseBeans** (list) - A list of Liquibase beans configured in the application. - **name** (string) - The name of the Liquibase bean. - **contexts** (list) - A list of contexts associated with this Liquibase instance. - **changeSets** (list) - A list of applied Liquibase changelogs. - **id** (string) - The ID of the changelog. - **author** (string) - The author of the changelog. - **tag** (string) - The tag associated with the changelog. - **md5sum** (string) - The MD5 checksum of the changelog. - **deploymentId** (string) - The ID of the deployment. - **datetime** (string) - The timestamp when the changelog was applied. ``` -------------------------------- ### Spring Integration Graph Source: https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html Generates a graph visualization of Spring Integration components and their connections. This helps in understanding the flow of messages and the structure of integration applications. ```APIDOC ## GET /actuator/integrationgraph ### Description Generates a graph visualization of Spring Integration components. ### Method GET ### Endpoint /actuator/integrationgraph ### Response #### Success Response (200) - The response body is a JSON object representing the Spring Integration graph, typically in GraphML format or a similar structure suitable for visualization. ``` -------------------------------- ### Health Source: https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html Returns the health of the application, including the status of various components like databases, disk space, and custom health indicators. This is a critical endpoint for monitoring application availability. ```APIDOC ## GET /actuator/health ### Description Returns the health of the application. ### Method GET ### Endpoint /actuator/health ### Response #### Success Response (200) - **status** (string) - The overall health status ('UP', 'DOWN', 'UNKNOWN'). - **components** (object) - An object containing the health status of individual components. - **componentName** (object) - Health details for a specific component. - **status** (string) - The status of the component ('UP', 'DOWN', 'UNKNOWN'). - **details** (object) - Additional details about the component's health (e.g., database connection info). ``` -------------------------------- ### Heap Dump Source: https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html Triggers the generation of a heap dump for the Java Virtual Machine. This is essential for diagnosing memory leaks and performance issues. ```APIDOC ## GET /actuator/heapdump ### Description Triggers the generation of a heap dump for the Java Virtual Machine. ### Method GET ### Endpoint /actuator/heapdump ### Response #### Success Response (200) - The response body will be the heap dump in HPROF binary format. ``` -------------------------------- ### Conditions Evaluation Report Source: https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html Generates a report detailing the evaluation of all conditional annotations used in the application's configuration. This helps in understanding why certain beans were or were not created. ```APIDOC ## GET /actuator/conditions ### Description Generates a report detailing the evaluation of all conditional annotations. ### Method GET ### Endpoint /actuator/conditions ### Response #### Success Response (200) - **condition** (object) - The root object for the conditions report. - **defaultValue** (string) - The default value used when no condition is met. - **entrySet** (list) - A list of entries detailing condition evaluations. - **element** (object) - Represents a single condition evaluation. - **condition** (object) - Details about the condition itself. - **match** (boolean) - Whether the condition was met. - **message** (string) - A message explaining the condition evaluation result. ``` -------------------------------- ### Loggers Source: https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html Provides access to and allows modification of the logging levels for different loggers in the application. This is essential for dynamic log management and debugging. ```APIDOC ## GET /actuator/loggers ### Description Provides access to and allows modification of logging levels. ### Method GET ### Endpoint /actuator/loggers ### Response #### Success Response (200) - **levels** (object) - An object where keys are logger names and values are available logging levels. - **loggers** (object) - An object where keys are logger names and values are their current configurations. - **configuredLevel** (string) - The currently configured logging level. - **effectiveLevel** (string) - The effective logging level, considering inheritance. ## PUT /actuator/loggers/{name} ### Description Configures the logging level for a specific logger. ### Method PUT ### Endpoint /actuator/loggers/{name} ### Parameters #### Path Parameters - **name** (string) - Required - The name of the logger to configure. #### Request Body - **configuredLevel** (string) - Required - The desired logging level (e.g., 'DEBUG', 'INFO', 'WARN', 'ERROR'). ``` -------------------------------- ### HTTP Exchanges Source: https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html Records and exposes HTTP request and response exchanges made by the application. This is useful for debugging and analyzing network communication. ```APIDOC ## GET /actuator/httpexchanges ### Description Records and exposes HTTP request and response exchanges. ### Method GET ### Endpoint /actuator/httpexchanges ### Parameters #### Query Parameters - **max-requests** (integer) - Optional - The maximum number of HTTP exchanges to store. ### Response #### Success Response (200) - **requests** (list) - A list of recorded HTTP exchange objects. - **request** (object) - Details of the HTTP request. - **method** (string) - The HTTP method. - **uri** (string) - The request URI. - **headers** (object) - Request headers. - **response** (object) - Details of the HTTP response. - **status** (integer) - The HTTP status code. - **headers** (object) - Response headers. - **elapsedTime** (string) - The time taken for the exchange. ``` -------------------------------- ### Audit Events Source: https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html Retrieves a list of audit events recorded by the application. This endpoint is useful for security auditing and tracking significant application events. ```APIDOC ## GET /actuator/auditevents ### Description Retrieves a list of audit events recorded by the application. ### Method GET ### Endpoint /actuator/auditevents ### Parameters #### Query Parameters - **principal** (string) - Optional - Filter events by principal. - **after** (string) - Optional - Filter events that occurred after a specific timestamp (ISO 8601 format). - **before** (string) - Optional - Filter events that occurred before a specific timestamp (ISO 8601 format). - **type** (string) - Optional - Filter events by type. - **sort** (string) - Optional - Sort order for events (e.g., 'time' or 'time:asc'). ### Response #### Success Response (200) - **orElse** (list) - A list of audit event objects. - **timestamp** (string) - The time the event occurred. - **principal** (string) - The user or system that performed the action. - **type** (string) - The type of event. - **tags** (object) - Additional tags associated with the event. ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.