Spring Boot

Spring Boot JVM API

The JVM API from Spring Boot — 2 operation(s) for jvm.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.spring.io/spring-boot/docs/current/actuator-api/htmlsingle/

Specifications

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

Schemas & Data

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

Other Resources

🔗
JSONLDContext
https://raw.githubusercontent.com/api-evangelist/spring-boot/refs/heads/main/json-ld/spring-boot-context.jsonld
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/spring-boot/refs/heads/main/rules/spring-boot-actuator-rules.yml

OpenAPI Specification

spring-boot-jvm-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Spring Boot Actuator Application JVM API
  description: Spring Boot Actuator exposes production-ready management and monitoring endpoints for Spring Boot applications. Endpoints provide health checks, metrics, environment info, configuration properties, thread dumps, and more.
  version: 3.3.0
  contact:
    name: Spring Team
    url: https://spring.io/projects/spring-boot
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:8080/actuator
  description: Default Actuator base path
tags:
- name: JVM
paths:
  /threaddump:
    get:
      operationId: getThreadDump
      summary: Spring Boot Thread dump
      description: Returns a snapshot of all threads in the JVM
      tags:
      - JVM
      responses:
        '200':
          description: Thread dump
          content:
            application/json:
              schema:
                type: object
  /heapdump:
    get:
      operationId: getHeapDump
      summary: Spring Boot Heap dump
      description: Returns an hprof heap dump file
      tags:
      - JVM
      responses:
        '200':
          description: Heap dump binary file
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary