Spring Framework Threads API

Thread dump and virtual thread information

OpenAPI Specification

spring-threads-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Spring Boot Actuator Beans Threads 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: Threads
  description: Thread dump and virtual thread information
paths:
  /threaddump:
    get:
      operationId: getThreadDump
      summary: Get Thread Dump
      description: Returns a snapshot of all threads running in the JVM, including their state, stack traces, and lock information. Useful for diagnosing deadlocks or performance issues.
      tags:
      - Threads
      responses:
        '200':
          description: JVM thread dump
          content:
            application/vnd.spring-boot.actuator.v3+json:
              schema:
                $ref: '#/components/schemas/ThreadDumpResponse'
components:
  schemas:
    ThreadDumpResponse:
      type: object
      properties:
        threads:
          type: array
          items:
            type: object
            properties:
              threadName:
                type: string
              threadId:
                type: integer
              blockedTime:
                type: integer
              blockedCount:
                type: integer
              waitedTime:
                type: integer
              waitedCount:
                type: integer
              lockName:
                type: string
                nullable: true
              lockOwnerId:
                type: integer
              lockOwnerName:
                type: string
                nullable: true
              daemon:
                type: boolean
              inNative:
                type: boolean
              suspended:
                type: boolean
              threadState:
                type: string
                enum:
                - NEW
                - RUNNABLE
                - BLOCKED
                - WAITING
                - TIMED_WAITING
                - TERMINATED
              priority:
                type: integer
              stackTrace:
                type: array
                items:
                  type: object
  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