> ## Documentation Index
> Fetch the complete documentation index at: https://dragonwingdocs.qualcomm.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Check the health of microservice

> Health check for container orchestration (Docker Swarm / Kubernetes). Returns HTTP 200 when healthy, HTTP 503 when unhealthy. Unhealthy conditions: any model has >= 3 consecutive inference failures (DSP/FastRPC fault), or available system memory < 100 MB.




## OpenAPI

````yaml /Ubuntu/ai-workflows/api-specs/llm-vlm-service/openapi.yaml get /v1/health
openapi: 3.0.3
info:
  title: LLM-VLM GenAI Microservice APIs
  description: >-
    These REST APIs provide the capability to run inference on Qualcomm
    Dragonwing devices.
  version: 1.0.0
servers:
  - url: http://{device-ip}:{device-port}/
    description: LLM-VLM Microservice API Server
    variables:
      device-ip:
        description: >-
          IP address and port of the host device running the LLM-VLM
          Microservice API
        default: localhost
      device-port:
        default: '9001'
security: []
paths:
  /v1/health:
    get:
      tags:
        - Health
      summary: Check the health of microservice
      description: >
        Health check for container orchestration (Docker Swarm / Kubernetes).
        Returns HTTP 200 when healthy, HTTP 503 when unhealthy. Unhealthy
        conditions: any model has >= 3 consecutive inference failures
        (DSP/FastRPC fault), or available system memory < 100 MB.
      operationId: healthcheck
      responses:
        '200':
          description: Service is healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
        '503':
          description: Service is unhealthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
components:
  schemas:
    HealthResponse:
      type: object
      title: Health Response
      description: Health check response for container orchestration.
      properties:
        status:
          type: string
          enum:
            - healthy
            - unhealthy
          description: Overall health status of the service.
        reason:
          type: string
          description: >
            Present only when status is "unhealthy". Describes the reason for
            the unhealthy state.
      required:
        - status

````