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

# Health check

> Returns OK if the service is running. Use for liveness probes.



## OpenAPI

````yaml /connectors/openapi/reit-openapi.json get /health
openapi: 3.1.0
info:
  title: PlanSo Connector
  description: >

    ## PlanSo Order Management Integration


    This connector provides a REST API for the PlanSo workshop management
    system, enabling order synchronization and queries.


    ### Features


    - **Order Sync**: Automatic background synchronization from PlanSo to local
    SQLite database

    - **Rich Queries**: Search orders by plate, person, phone, email, status,
    damage type, and date ranges

    - **Parts Tracking**: View parts lists with order/delivery status

    - **CRUD Operations**: Create, update, and delete orders in PlanSo


    ### Sync Architecture


    The connector maintains a local SQLite database that mirrors PlanSo data:


    1. **Background Sync**: Runs automatically during business hours
    (configurable)

    2. **Manual Sync**: Trigger via `/api/sync` endpoint

    3. **Incremental Updates**: Only fetches changed orders when possible


    ### Data Model


    - **Orders**: Repair projects with customer, vehicle, and scheduling info

    - **Parts**: Individual parts linked to orders with ordering/delivery status

    - **Extended Data**: Damaged areas, documents, images (optional sync)


    ### Authentication


    All endpoints (except `/health` and `/ready`) require an `X-API-Key` header.
    Requests may also be restricted by IP whitelist.
  contact:
    name: AICO Engineering
    url: https://aicoflow.com/
  license:
    name: Proprietary
  version: 1.0.0
servers:
  - url: https://reit.connectors.aicoflow.com
    description: Production
  - url: http://localhost:8102
    description: Local development
security:
  - ApiKeyAuth: []
tags:
  - name: Authentication
    description: PlanSo session management. Login and maintain authenticated sessions.
  - name: Sync
    description: >-
      Data synchronization operations. Trigger manual syncs and monitor sync
      status.
  - name: Orders
    description: Order management. Query, create, update, and delete repair orders.
  - name: Parts
    description: Parts information. View parts lists and status for orders.
  - name: Health
    description: Service health and readiness checks.
paths:
  /health:
    get:
      tags:
        - Health
      summary: Health check
      description: Returns OK if the service is running. Use for liveness probes.
      operationId: health_health_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````