Helidon Health API

openapi: 3.0.3
info:
  title: Helidon Observe ( & Metrics) Health API
  description: Helidon provides built-in observability endpoints following the MicroProfile Health and MicroProfile Metrics specifications. These endpoints expose application health status, readiness, liveness, startup checks, and application/vendor/base metrics. In Helidon 4.x, these are served under the /observe path by default.
  version: 4.1.0
  contact:
    name: Helidon Team
    url: https://helidon.io/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:8080
  description: Default Helidon server
tags:
- name: Health
paths:
  /observe/health:
    get:
      operationId: getHealth
      summary: Helidon Overall health status
      description: Returns aggregate health check results from all registered health checks
      tags:
      - Health
      responses:
        '200':
          description: All health checks pass
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
        '503':
          description: One or more health checks failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
  /observe/health/live:
    get:
      operationId: getLiveness
      summary: Helidon Liveness check
      description: Returns liveness health check results (for Kubernetes liveness probes)
      tags:
      - Health
      responses:
        '200':
          description: Application is live
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
        '503':
          description: Application is not live
  /observe/health/ready:
    get:
      operationId: getReadiness
      summary: Helidon Readiness check
      description: Returns readiness health check results (for Kubernetes readiness probes)
      tags:
      - Health
      responses:
        '200':
          description: Application is ready
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
        '503':
          description: Application is not ready
  /observe/health/started:
    get:
      operationId: getStartup
      summary: Helidon Startup check
      description: Returns startup health check results (for Kubernetes startup probes)
      tags:
      - Health
      responses:
        '200':
          description: Application has started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
        '503':
          description: Application has not started
components:
  schemas:
    HealthCheckResponse:
      type: object
      description: MicroProfile Health response
      properties:
        status:
          type: string
          enum:
          - UP
          - DOWN
          description: Aggregate health status
        checks:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                description: Health check name
              status:
                type: string
                enum:
                - UP
                - DOWN
              data:
                type: object
                additionalProperties: true
                description: Additional health check data