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

# Aggregate health report

> Runs every registered health checker (BACEN connectivity, TLS
certificate validity, credential expiry, worker heartbeat,
scheduler leader, rate budget, license state), aggregates them
worst-of, and returns the structured report. The HTTP status
mirrors the aggregate: healthy=200, warning=207 (Multi-Status),
critical=503. A report-source failure returns 503 with a
structured product-error body.



## OpenAPI

````yaml en/openapi/v3-current/sta.yaml get /v1/health
openapi: 3.0.3
info:
  title: Lerian STA API
  description: >-
    API for Lerian STA — the participant-side rail that connects the institution
    to Banco Central do Brasil's STA (Sistema de Transferencia de Arquivos)
    file-exchange system. It covers outbound and inbound file transfers, BACEN
    credential management, inbound source polling configuration, and the tenant
    trust-store for message-signing certificates.
  version: v1.0.0
servers:
  - url: https://sta.sandbox.lerian.net
security:
  - BearerAuth: []
tags:
  - name: transfers
    description: >-
      Outbound and inbound STA file transfers — creation, listing, read,
      cancellation, retry, and urgent-processing marking.
  - name: trust-store
    description: >-
      Tenant trust-store X.509 certificate lifecycle: listing, upload, deletion,
      and status summary.
  - name: credentials
    description: >-
      BACEN STA credential management: creation, read, update, rotation,
      revocation, and connectivity testing.
  - name: inbound-source-configs
    description: >-
      Inbound source polling configuration: creation, read, update, deletion,
      manual poll triggering, and discovery reserve usage.
  - name: health
    description: Service health and readiness reporting.
paths:
  /v1/health:
    get:
      tags:
        - health
      summary: Aggregate health report
      description: |-
        Runs every registered health checker (BACEN connectivity, TLS
        certificate validity, credential expiry, worker heartbeat,
        scheduler leader, rate budget, license state), aggregates them
        worst-of, and returns the structured report. The HTTP status
        mirrors the aggregate: healthy=200, warning=207 (Multi-Status),
        critical=503. A report-source failure returns 503 with a
        structured product-error body.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http.reportView'
        '207':
          description: Multi-Status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http.reportView'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
components:
  schemas:
    http.reportView:
      properties:
        checks:
          items:
            $ref: '#/components/schemas/http.checkView'
          type: array
        generatedAt:
          type: string
        status:
          type: string
      type: object
    http.checkView:
      properties:
        checkedAt:
          type: string
        detail:
          type: string
        name:
          type: string
        status:
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      description: 'Bearer token authentication (format: "Bearer {token}")'
      in: header
      name: Authorization
      type: apiKey

````