Spring Batch 5.1

Spring Batch 5.1 Health API

Application and component health checks

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.spring.io/spring-batch/docs/5.1.x/reference/html/

Specifications

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

SDKs

📦
GitHubRepository
https://github.com/spring-projects/spring-batch

Other Resources

🔗
API Documentation
https://docs.spring.io/spring-batch/docs/5.1.x/api/
🔗
Getting Started Guide
https://spring.io/guides/gs/batch-processing/
🔗
Reference Guide
https://docs.spring.io/spring-batch/docs/5.1.x/reference/html/index-single.html
🔗
Samples
https://github.com/spring-projects/spring-batch/tree/main/spring-batch-samples
🔗
ReleaseNotes
https://github.com/spring-projects/spring-batch/releases/tag/5.1.0
🔗
Maven Central
https://mvnrepository.com/artifact/org.springframework.batch/spring-batch-core/5.1.0
🔗
Migration Guide
https://github.com/spring-projects/spring-batch/wiki/Spring-Batch-5.0-Migration-Guide
🔗
ChangeLog
https://github.com/spring-projects/spring-batch/blob/main/CHANGELOG.md
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/spring-batch-5-1/refs/heads/main/rules/spring-batch-51-rules.yml

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-batch-5-1-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 email required.

GitHub Google LinkedIn

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

OpenAPI Specification

spring-batch-5-1-health-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Spring Batch 5.1 Actuator Batch Jobs Health API
  description: Spring Boot Actuator endpoints exposed by Spring Batch 5.1 applications for monitoring and managing batch jobs. Provides health checks, metrics, job execution status, and step execution details via the Spring Boot Actuator infrastructure. These endpoints are available when spring-boot-actuator is on the classpath alongside spring-batch-core.
  version: 5.1.0
  contact:
    name: Spring Team
    url: https://spring.io/team
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:8080/actuator
  description: Local Spring Boot application with Actuator enabled
tags:
- name: Health
  description: Application and component health checks
paths:
  /health:
    get:
      operationId: getHealth
      summary: Get Application Health
      description: Returns the health status of the Spring Batch application including database connectivity and batch job health indicators.
      tags:
      - Health
      responses:
        '200':
          description: Application is healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
        '503':
          description: Application is unhealthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
  /health/batch:
    get:
      operationId: getBatchHealth
      summary: Get Batch Health
      description: Returns health status specific to Spring Batch, including job repository connectivity and last job execution status.
      tags:
      - Health
      responses:
        '200':
          description: Batch subsystem is healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentHealth'
components:
  schemas:
    ComponentHealth:
      type: object
      description: Health status of a single component
      properties:
        status:
          type: string
          description: Component health status
          enum:
          - UP
          - DOWN
          - OUT_OF_SERVICE
          - UNKNOWN
        details:
          type: object
          description: Additional details about the component health
          additionalProperties: true
    HealthResponse:
      type: object
      description: Overall application health status
      properties:
        status:
          type: string
          description: Health status
          enum:
          - UP
          - DOWN
          - OUT_OF_SERVICE
          - UNKNOWN
        components:
          type: object
          description: Health of individual components
          additionalProperties:
            $ref: '#/components/schemas/ComponentHealth'