description: Spring Boot Actuator Web API Documentation
url: https://docs.spring.io/spring-boot/docs/current/actuator-api/html/
paths:
+ /actuator/threaddump:
+ get:
+ tags:
+ - Actuator
+ summary: Actuator web endpoint 'threaddump'
+ operationId: threaddump
+ responses:
+ 200:
+ description: OK
+ content:
+ text/plain;charset=UTF-8:
+ schema:
+ type: object
+ application/vnd.spring-boot.actuator.v3+json:
+ schema:
+ type: object
+ application/json:
+ schema:
+ type: object
+ application/vnd.spring-boot.actuator.v2+json:
+ schema:
+ type: object
+ /actuator/info:
+ get:
+ tags:
+ - Actuator
+ summary: Actuator web endpoint 'info'
+ operationId: info
+ responses:
+ 200:
+ description: OK
+ content:
+ application/vnd.spring-boot.actuator.v3+json:
+ schema:
+ type: object
+ application/json:
+ schema:
+ type: object
+ application/vnd.spring-boot.actuator.v2+json:
+ schema:
+ type: object
+ /actuator/loggers:
+ get:
+ tags:
+ - Actuator
+ summary: Actuator web endpoint 'loggers'
+ operationId: loggers
+ responses:
+ 200:
+ description: OK
+ content:
+ application/vnd.spring-boot.actuator.v3+json:
+ schema:
+ type: object
+ application/json:
+ schema:
+ type: object
+ application/vnd.spring-boot.actuator.v2+json:
+ schema:
+ type: object
+ /actuator/health/**:
+ get:
+ tags:
+ - Actuator
+ summary: Actuator web endpoint 'health-path'
+ operationId: health-path
+ responses:
+ 200:
+ description: OK
+ content:
+ application/vnd.spring-boot.actuator.v3+json:
+ schema:
+ type: object
+ application/json:
+ schema:
+ type: object
+ application/vnd.spring-boot.actuator.v2+json:
+ schema:
+ type: object
+ /actuator/shutdown:
+ post:
+ tags:
+ - Actuator
+ summary: Actuator web endpoint 'shutdown'
+ operationId: shutdown
+ responses:
+ 200:
+ description: OK
+ content:
+ application/vnd.spring-boot.actuator.v3+json:
+ schema:
+ type: object
+ application/json:
+ schema:
+ type: object
+ application/vnd.spring-boot.actuator.v2+json:
+ schema:
+ type: object
/actuator/metrics/{requiredMetricName}:
get:
tags:
- Actuator
summary: Actuator web endpoint 'metrics-requiredMetricName'
- operationId: metrics-requiredMetricName_2
+ operationId: metrics-requiredMetricName
parameters:
- name: requiredMetricName
in: path
200:
description: OK
content:
- '*/*':
+ application/vnd.spring-boot.actuator.v3+json:
+ schema:
+ type: object
+ application/json:
+ schema:
+ type: object
+ application/vnd.spring-boot.actuator.v2+json:
schema:
type: object
/actuator:
tags:
- Actuator
summary: Actuator root web endpoint
- operationId: links_1
+ operationId: links
responses:
200:
description: OK
content:
- '*/*':
+ application/vnd.spring-boot.actuator.v3+json:
schema:
type: object
additionalProperties:
type: object
additionalProperties:
$ref: '#/components/schemas/Link'
- /actuator/threaddump:
+ application/json:
+ schema:
+ type: object
+ additionalProperties:
+ type: object
+ additionalProperties:
+ $ref: '#/components/schemas/Link'
+ application/vnd.spring-boot.actuator.v2+json:
+ schema:
+ type: object
+ additionalProperties:
+ type: object
+ additionalProperties:
+ $ref: '#/components/schemas/Link'
+ /actuator/logfile:
get:
tags:
- Actuator
- summary: Actuator web endpoint 'threaddump'
- operationId: threaddump_4
+ summary: Actuator web endpoint 'logfile'
+ operationId: logfile
responses:
200:
description: OK
content:
- '*/*':
+ text/plain;charset=UTF-8:
schema:
type: object
- /actuator/logfile:
- get:
+ /data-consumer/v1/info-jobs/{infoJobId}:
+ put:
tags:
- - Actuator
- summary: Actuator web endpoint 'logfile'
- operationId: logfile_2
+ - Information Coordinator Service Simulator (exists only in test)
+ operationId: putIndividualInfoJob
+ parameters:
+ - name: infoJobId
+ in: path
+ required: true
+ style: simple
+ explode: false
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: string
+ required: true
responses:
200:
description: OK
content:
- '*/*':
+ application/json:
schema:
type: object
/actuator/loggers/{name}:
tags:
- Actuator
summary: Actuator web endpoint 'loggers-name'
- operationId: loggers-name_4
+ operationId: loggers-name
parameters:
- name: name
in: path
200:
description: OK
content:
- '*/*':
+ application/vnd.spring-boot.actuator.v3+json:
+ schema:
+ type: object
+ application/json:
+ schema:
+ type: object
+ application/vnd.spring-boot.actuator.v2+json:
schema:
type: object
post:
tags:
- Actuator
summary: Actuator web endpoint 'loggers-name'
- operationId: loggers-name_3
+ operationId: loggers-name_2
parameters:
- name: name
in: path
explode: false
schema:
type: string
- responses:
- 200:
- description: OK
- content:
- '*/*':
- schema:
- type: object
- /actuator/info:
- get:
- tags:
- - Actuator
- summary: Actuator web endpoint 'info'
- operationId: info_2
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: string
+ enum:
+ - TRACE
+ - DEBUG
+ - INFO
+ - WARN
+ - ERROR
+ - FATAL
+ - OFF
responses:
200:
description: OK
tags:
- Actuator
summary: Actuator web endpoint 'health'
- operationId: health_2
+ operationId: health
responses:
200:
description: OK
content:
- '*/*':
+ application/vnd.spring-boot.actuator.v3+json:
schema:
type: object
- /actuator/loggers:
- get:
- tags:
- - Actuator
- summary: Actuator web endpoint 'loggers'
- operationId: loggers_2
- responses:
- 200:
- description: OK
- content:
- '*/*':
+ application/json:
schema:
type: object
- /actuator/health/**:
- get:
- tags:
- - Actuator
- summary: Actuator web endpoint 'health-path'
- operationId: health-path_2
- responses:
- 200:
- description: OK
- content:
- '*/*':
+ application/vnd.spring-boot.actuator.v2+json:
schema:
type: object
/actuator/metrics:
tags:
- Actuator
summary: Actuator web endpoint 'metrics'
- operationId: metrics_2
+ operationId: metrics
responses:
200:
description: OK
content:
- '*/*':
+ application/vnd.spring-boot.actuator.v3+json:
+ schema:
+ type: object
+ application/json:
+ schema:
+ type: object
+ application/vnd.spring-boot.actuator.v2+json:
schema:
type: object
/actuator/heapdump:
tags:
- Actuator
summary: Actuator web endpoint 'heapdump'
- operationId: heapdump_2
+ operationId: heapdump
responses:
200:
description: OK
content:
- '*/*':
- schema:
- type: object
- /actuator/shutdown:
- post:
- tags:
- - Actuator
- summary: Actuator web endpoint 'shutdown'
- operationId: shutdown_2
- responses:
- 200:
- description: OK
- content:
- '*/*':
+ application/octet-stream:
schema:
type: object
components: