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

# Service health heartbeat

> Basic health probe that validates the service is running.



## OpenAPI

````yaml https://api.contracting.kukkingu.software/api/v1/docs.json get /api/v1/health
openapi: 3.1.0
info:
  title: Contracting Backend API
  version: 0.1.0
  description: API documentation for the Contracting backend service.
servers:
  - url: https://api.contracting.kukkingu.software
    description: API server
security:
  - bearerAuth: []
paths:
  /api/v1/health:
    get:
      tags:
        - Health
      summary: Service health heartbeat
      description: Basic health probe that validates the service is running.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                    example: contracting-sdk
                  version:
                    type: string
                    example: 1.0.0
                  status:
                    type: string
                    enum:
                      - ok
                      - impaired
                      - down
                    description: Operational status of the service.
                    example: ok
                required:
                  - name
                  - version
                  - status
                additionalProperties: false
                description: Service health status.
      security: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````