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

# Health

> Aggregate health of the LENS API and its upstream services (Typesense, Redis, database). Returns 200 when all critical services are reachable and 503 when any is not. Anonymous callers receive service status and upcoming SLA windows; authenticated callers additionally receive their current rate-limit state.

This endpoint allows you to get our status health. It doesn't require any token or authentication. If you provide your authentication with your x-api-key or included
in the querystring we will respond back also with the current limits for the API key equals the header data you receive for X-RateLimit-\*.

Response also includes information about any upcoming service windows. Example:

```json Response for health with upcoming service window theme={null}
{
  "ok": true,
  "upcomingServiceWindows": [
    {
      "startDateUtc": "2025-02-02T06:00:00",
      "endDateUtc": "2025-02-02T06:05:00",
      "notes": "Just for demonstration",
      "lastUpdatedAtUtc": "2025-02-01T08:52:43"
    }
  ],
  "limits": {
    "rateLimitReset": 2435948,
    "rateLimit": 3000,
    "rateLimitRemaining": 2965,
    "rateLimitMinute": 960,
    "rateLimitIP": 200
  }
}
```


## OpenAPI

````yaml get /free/health
openapi: 3.0.4
info:
  title: TIC API
  description: ''
  version: v1
servers:
  - url: https://api.tic.io/
security:
  - ApiKey: []
tags:
  - name: BolagsverketStatistics
  - name: Companies
  - name: Companies_SE_
  - name: DocumentDelivery
  - name: EuropeanCommission
  - name: FinancialDocuments
  - name: Finansinspektionen
  - name: Free
  - name: ICA
  - name: ICAStatistics
  - name: Lists
  - name: Media
  - name: Persons
  - name: Persons_SE_
  - name: Properties_SE_
  - name: PTSPortings
  - name: Reseller
  - name: SearchBankruptciesReports
  - name: SearchCompanies
  - name: SearchCompaniesReports
  - name: SearchCompanyWorkplaces
  - name: SearchPerson
  - name: SearchProperties_SE_
  - name: SearchVehicles
  - name: TeamDocumentOrders
  - name: Teams
  - name: User
  - name: Vehicles_SE_
  - name: WatchLists
paths:
  /free/health:
    get:
      tags:
        - Free
      summary: Health
      description: Gets health status for our API, search and other services
      operationId: Health
      responses:
        '200':
          description: The health response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Ormeo_WebAPI_Models_External_HealthSearch_Dto
components:
  schemas:
    Ormeo_WebAPI_Models_External_HealthSearch_Dto:
      type: object
      properties:
        ok:
          type: boolean
        upcomingServiceWindows:
          type: array
          items:
            $ref: >-
              #/components/schemas/Ormeo_WebAPI_Models_External_SLA_ServiceWindow_Dto
          nullable: true
        limits:
          $ref: >-
            #/components/schemas/Ormeo_WebAPI_Models_External_HealthSearchLimits_Dto
      additionalProperties: false
    Ormeo_WebAPI_Models_External_SLA_ServiceWindow_Dto:
      type: object
      properties:
        startDateUtc:
          type: string
          format: date-time
        endDateUtc:
          type: string
          format: date-time
        notes:
          type: string
          nullable: true
        lastUpdatedAtUtc:
          type: string
          format: date-time
      additionalProperties: false
    Ormeo_WebAPI_Models_External_HealthSearchLimits_Dto:
      type: object
      properties:
        rateLimitReset:
          type: integer
          format: int32
        rateLimit:
          type: integer
          format: int32
        rateLimitRemaining:
          type: integer
          format: int32
        rateLimitMinute:
          type: integer
          format: int32
        rateLimitIP:
          type: integer
          format: int32
      additionalProperties: false
  securitySchemes:
    ApiKey:
      type: apiKey
      name: x-api-key
      in: header

````