Spring Framework Health API

openapi: 3.1.0
info:
  title: Spring Boot Actuator Beans Health API
  description: The Spring Boot Actuator API provides production-ready endpoints for monitoring and managing Spring Boot applications. It exposes health checks, metrics, environment information, configuration properties, thread dumps, HTTP traces, application info, and shutdown capabilities via RESTful endpoints. The Actuator supports customizable security, endpoint exposure controls, and integration with monitoring systems like Prometheus, Datadog, and CloudWatch. Used by operators and SREs to observe and manage deployed Spring Boot services.
  version: 3.x
  contact:
    name: Spring Team
    url: https://spring.io/support
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:8080/actuator
  description: Default Local Spring Boot Actuator Endpoint
security:
- basicAuth: []
tags:
- name: Health
  description: Application health status and component health details
paths:
  /health:
    get:
      operationId: getHealth
      summary: Get Health Status
      description: Returns the health status of the application and all registered health indicators (database, disk space, Redis, Kafka, etc.). The response detail level is controlled by the management.endpoint.health.show-details configuration property.
      tags:
      - Health
      responses:
        '200':
          description: Application is healthy
          content:
            application/vnd.spring-boot.actuator.v3+json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
        '503':
          description: Application is unhealthy or out of service
          content:
            application/vnd.spring-boot.actuator.v3+json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
  /health/{component}:
    get:
      operationId: getComponentHealth
      summary: Get Component Health Status
      description: Returns health details for a specific health indicator component.
      tags:
      - Health
      parameters:
      - name: component
        in: path
        required: true
        description: Health indicator component name (e.g., db, diskSpace, redis)
        schema:
          type: string
        example: db
      responses:
        '200':
          description: Component health details
          content:
            application/vnd.spring-boot.actuator.v3+json:
              schema:
                $ref: '#/components/schemas/ComponentHealthResponse'
components:
  schemas:
    ComponentHealthResponse:
      type: object
      description: Health status for a single health indicator component
      properties:
        status:
          type: string
          enum:
          - UP
          - DOWN
          - OUT_OF_SERVICE
          - UNKNOWN
          example: UP
        details:
          type: object
          description: Component-specific health details
          additionalProperties: true
    HealthResponse:
      type: object
      description: Application health status response
      properties:
        status:
          type: string
          description: Overall health status
          enum:
          - UP
          - DOWN
          - OUT_OF_SERVICE
          - UNKNOWN
          example: UP
        components:
          type: object
          description: Health details per registered health indicator
          additionalProperties:
            $ref: '#/components/schemas/ComponentHealthResponse'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
externalDocs:
  description: Spring Boot Actuator Reference Documentation
  url: https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html