Spring Framework

Spring Framework Health API

Application health status and component health details

GitHub OpenAPI

Operations 2

GET /health Get Health Status #
GET /health/{component} Get Component Health Status #

Documentation

📖
Documentation
https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html
📖
GettingStarted
https://spring.io/guides/gs/spring-boot/
📖
Documentation
https://docs.spring.io/initializr/docs/current/reference/html/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/spring/refs/heads/main/openapi/spring-health-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/spring/refs/heads/main/json-schema/spring-actuator-health-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/spring/refs/heads/main/json-schema/spring-boot-application-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/spring/refs/heads/main/json-structure/spring-boot-application-structure.json

Other Resources

🔗
GitHub
https://github.com/spring-projects/spring-boot
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/spring/refs/heads/main/rules/spring-rules.yml
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/spring/refs/heads/main/vocabulary/spring-vocabulary.yml
🔗
OpenAPIUpstream
https://start.spring.io/v3/api-docs
🔗
GitHub
https://github.com/spring-io/initializr
🔗
WebInterface
https://start.spring.io
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/spring/refs/heads/main/json-ld/spring-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/spring-health-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

spring-health-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Spring Boot Actuator Health API
  description: The Spring Boot Actuator API provides production-ready endpoints for monitoring and managing Spring Boot applications.
  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