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

# Liveness probe

> Lightweight liveness check for container orchestrators (Kubernetes, Docker, ECS).

      **Scope**
      Verifies only that the process is alive and serving HTTP traffic.
      Does **not** check DB or Redis connectivity — use `/readiness` for that.

      **Performance**
      Constant-time, no I/O. Safe to poll every 1–5 seconds.



## OpenAPI

````yaml /api-reference/openapi.json get /health
openapi: 3.0.0
info:
  title: Xenios Trading API
  description: >-
    Place and manage orders, stream live market and account data, and read
    wallets, deposits and reference data over one authenticated gateway. All
    protected endpoints are authenticated with an HMAC-SHA256 request signature
    (see the Authentication guide). Decimal amounts are strings; timestamps are
    ISO-8601. Successful responses are wrapped in a standard { statusCode,
    success, message, data } envelope.
  version: '1.0'
  contact: {}
servers:
  - url: https://<your-host>/api/v1/trading
    description: Development gateway. Prefix every trading path with this base URL.
security:
  - xenios-hmac: []
tags:
  - name: Orders
    description: >-
      Place, cancel, and read your orders. Placement is idempotent on
      client_order_id.
  - name: Order Book
    description: Top-of-book depth snapshots for a trading pair.
  - name: Products
    description: Tradable products and pairs, plus OHLCV candles for charting.
  - name: Assets
    description: The assets available to your account.
  - name: Wallets
    description: Generate deposit addresses and read deposit history.
  - name: Account
    description: Your trading fee and effective account settings.
  - name: Health
    description: Liveness and readiness probes.
paths:
  /health:
    servers:
      - url: https://<your-host>/api/v1
        description: >-
          Development gateway root. Health and readiness probes live outside the
          trading base path.
    get:
      tags:
        - Health
      summary: Liveness probe
      description: >-
        Lightweight liveness check for container orchestrators (Kubernetes,
        Docker, ECS).

              **Scope**
              Verifies only that the process is alive and serving HTTP traffic.
              Does **not** check DB or Redis connectivity — use `/readiness` for that.

              **Performance**
              Constant-time, no I/O. Safe to poll every 1–5 seconds.
      operationId: getAppHealth
      parameters: []
      responses:
        '200':
          description: Process is alive and accepting requests.
          content:
            text/plain:
              schema:
                type: string
                example: running
        '503':
          description: Process is starting up, shutting down, or unhealthy.
components:
  securitySchemes:
    xenios-hmac:
      type: apiKey
      in: header
      name: X-API-KEY
      description: >-
        HMAC-SHA256 authentication. Sign every request and send X-API-KEY,
        X-API-SIGNATURE, X-API-TIMESTAMP and X-API-NONCE (see the Authentication
        guide). Each route also requires a specific claim on your API key (e.g.
        read:orders, write:orders, read:account, read:market-data).

````