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

# Health probe

> Returns liveness information for infrastructure monitors.



## OpenAPI

````yaml /openapi.json get /api/health/
openapi: 3.0.3
info:
  title: TBBO API
  version: 1.0.0
  description: >
    Authentication uses short-lived session tokens (3 hours).


    Send the token with every request using the `Authorization` header:


    ```

    Authorization: Token <token>

    ```


    Example:


    ```

    Authorization: Token 123abc456def789

    ```


    To obtain a token, call `POST /auth/login/` with valid credentials. The
    response includes a `key` value. Use that value in the header above for
    subsequent API calls.


    How to find required IDs:


    - `challenge_id`: Prop Tech Configuration -> Challenges

    - `user_id`: Tickblaze Manager -> Users

    - `account_id`: Tickblaze Manager -> Accounts 
servers: []
security: []
tags:
  - name: withdrawals
    description: Withdrawal related endpoints
    x-displayName: Withdrawals
paths:
  /api/health/:
    get:
      tags:
        - Status
      summary: Health probe
      description: Returns liveness information for infrastructure monitors.
      operationId: api_health_retrieve
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthStatus'
              examples:
                HealthyResponse:
                  value:
                    status: healthy
                    timestamp: '2026-01-27T21:50:58.873423Z'
                    version: null
                  summary: Service is healthy
          description: ''
      security:
        - {}
components:
  schemas:
    HealthStatus:
      type: object
      properties:
        status:
          type: string
          description: Health status for this check.
        timestamp:
          type: string
          format: date-time
          description: Time the health response was generated.
        version:
          type: string
          description: >-
            Application version when available; may be null when no version is
            reported.
      required:
        - status
        - timestamp
        - version

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.