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

# System

> Check API health and system status

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://app.codethreat.com/api/v1/health'
  ```
</RequestExample>


## OpenAPI

````yaml GET /health
openapi: 3.0.3
info:
  title: CodeThreat API
  version: 1.0.0
  description: >-
    Autonomous AppSec Engineering Platform - Comprehensive REST API for security
    scanning, vulnerability management, and DevSecOps automation. Integrate
    CodeThreat's powerful security analysis into your CI/CD pipeline, CLI tools,
    and third-party applications.
  contact:
    name: CodeThreat Support
    url: https://codethreat.com/support
    email: support@codethreat.com
  license:
    name: Proprietary
    url: https://codethreat.com/terms
  termsOfService: https://codethreat.com/terms
servers:
  - url: https://app.codethreat.com/api/v1
    description: Production Server
  - url: http://localhost:3000/api/v1
    description: Development Server
security:
  - ApiKeyAuth: []
tags:
  - name: Organizations
    description: Organization management and configuration
  - name: Repositories
    description: Repository management and status tracking
  - name: Scans
    description: Security scan execution, monitoring, and results
  - name: Violations
    description: Security violation tracking and management
  - name: CLI
    description: CLI-specific endpoints for authentication and configuration
  - name: System
    description: Health checks and system status
paths:
  /health:
    get:
      tags:
        - System
      summary: Health check
      description: Check API health and system status
      operationId: healthCheck
      responses:
        '200':
          description: System healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
        '503':
          description: System unhealthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
      security: []
components:
  schemas:
    HealthCheckResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            status:
              type: string
              enum:
                - healthy
                - degraded
                - unhealthy
            version:
              type: string
            timestamp:
              type: string
              format: date-time
            services:
              type: object
              properties:
                database:
                  type: string
                  enum:
                    - up
                    - down
                redis:
                  type: string
                  enum:
                    - up
                    - down
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication. Generate from your organization settings.

````