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

# Authenticated health check endpoint



## OpenAPI

````yaml /swagger.yml get /api/v0/health
openapi: 3.0.0
info:
  title: Devdraft AI Payment & Business Management API
  description: >-

    A comprehensive payment processing and business management API that enables
    seamless integration of cryptocurrency and traditional payment methods.
        
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.devdraft.ai
    description: Production Server
security: []
tags: []
paths:
  /api/v0/health:
    get:
      tags:
        - API Health
      summary: Authenticated health check endpoint
      operationId: HealthController_check_v0
      parameters: []
      responses:
        '200':
          description: Service is up and running
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponseDto'
        '401':
          description: Unauthorized. Client key or secret is invalid or missing.
      security:
        - x-client-secret: []
        - x-client-key: []
components:
  schemas:
    HealthResponseDto:
      type: object
      properties:
        status:
          type: string
          description: >-
            Overall health status of the service. Returns "ok" when healthy,
            "error" when issues detected.
          example: ok
          enum:
            - ok
            - error
        timestamp:
          type: string
          description: ISO 8601 timestamp when the health check was performed.
          example: '2023-07-01T12:00:00.000Z'
          format: date-time
        version:
          type: string
          description: >-
            Current version of the API service. Useful for debugging and
            compatibility checks.
          example: 1.0.0
        database:
          type: string
          description: >-
            Database connectivity status. Shows "connected" when database is
            accessible, "error" when connection fails.
          example: connected
          enum:
            - connected
            - error
        message:
          type: string
          description: >-
            Human-readable message describing the current health status and any
            issues.
          example: Service is up and running
        authenticated:
          type: boolean
          description: >-
            Indicates whether the request was properly authenticated. Always
            true for this endpoint since authentication is required.
          example: true
      required:
        - status
        - timestamp
        - version
        - database
        - message
        - authenticated
  securitySchemes:
    x-client-secret:
      type: apiKey
      in: header
      name: x-client-secret
      description: >-
        Your secret API key. Keep this secure and never expose it in client-side
        code.
    x-client-key:
      type: apiKey
      in: header
      name: x-client-key
      description: Your unique client API key. Obtain this from your Devdraft AI dashboard.

````