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

# Health Check

> Verifies the API is running and responding.



## OpenAPI

````yaml get /api/v1/health
openapi: 3.0.3
info:
  title: OneFirewall Offensive Security API
  description: >-
    API endpoints for the Vulnix Scanner, user management, and configuration.


    ## Authentication


    Authentication is handled via API keys. You must include your key in the
    `api-key` header with every request.


    - **Header**: `api-key: {your-api-key}`

    - **Key Format**: A single secret string provided upon creation.


    ## Organization Context


    For endpoints requiring an organization context (like scanning), you can
    specify your organization ID:


    - **Header**: `X-Org-Id: {your-org-id}`

    - **Query Parameter**: `?org_id={your-org-id}`


    If not provided, the request will use your default organization.
  version: 1.0.0
servers:
  - url: https://vulnix0.com
    description: Production server
security:
  - apiKeyAuth: []
paths:
  /api/v1/health:
    get:
      tags:
        - Utilities
      summary: Health Check
      description: Verifies the API is running and responding.
      responses:
        '200':
          description: API is healthy
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: ok
      security: []
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: api-key
      description: A unique API Key.

````