Spring Framework Beans API

Spring application context beans

OpenAPI Specification

spring-beans-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Spring Boot Actuator Beans 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: Beans
  description: Spring application context beans
paths:
  /beans:
    get:
      operationId: getBeans
      summary: Get Application Beans
      description: Returns a complete list of Spring beans instantiated in the application context, along with their type, scope, and dependencies.
      tags:
      - Beans
      responses:
        '200':
          description: Spring application context beans
          content:
            application/vnd.spring-boot.actuator.v3+json:
              schema:
                $ref: '#/components/schemas/BeansResponse'
components:
  schemas:
    BeansResponse:
      type: object
      properties:
        contexts:
          type: object
          additionalProperties:
            type: object
            properties:
              beans:
                type: object
                additionalProperties:
                  type: object
                  properties:
                    aliases:
                      type: array
                      items:
                        type: string
                    scope:
                      type: string
                    type:
                      type: string
                    resource:
                      type: string
                    dependencies:
                      type: array
                      items:
                        type: string
  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