> ## 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.

# Relatório de saúde agregado

> Executa cada verificador de saúde registrado (conectividade com o BACEN, validade do certificado TLS, expiração de credenciais, heartbeat do worker, líder do scheduler, orçamento de taxa, estado da licença), agrega-os em modo worst-of e retorna o relatório estruturado. O status HTTP espelha o agregado: healthy=200, warning=207 (Multi-Status), critical=503. Uma falha na fonte do relatório retorna 503 com um corpo de erro de produto estruturado.



## OpenAPI

````yaml pt/openapi/v3-current/sta.yaml get /v1/health
openapi: 3.0.3
info:
  title: Lerian STA API
  description: >-
    API do Lerian STA — o rail do lado do participante que conecta a instituição
    ao sistema de troca de arquivos STA (Sistema de Transferência de Arquivos)
    do Banco Central do Brasil. Abrange as transferências de arquivos de saída e
    de entrada, a gestão de credenciais do BACEN, a configuração da sondagem de
    fontes de entrada e o trust-store do tenant para os certificados de
    assinatura de mensagens.
  version: v1.0.0
servers:
  - url: https://sta.sandbox.lerian.net
security:
  - BearerAuth: []
tags:
  - name: transfers
    description: >-
      Transferências de arquivos STA de saída e de entrada — criação, listagem,
      leitura, cancelamento, nova tentativa e marcação de processamento urgente.
  - name: trust-store
    description: >-
      Ciclo de vida dos certificados X.509 do trust-store do tenant: listagem,
      upload, exclusão e resumo de status.
  - name: credentials
    description: >-
      Gestão de credenciais do BACEN STA: criação, leitura, atualização,
      rotação, revogação e teste de conectividade.
  - name: inbound-source-configs
    description: >-
      Configuração da sondagem de fontes de entrada: criação, leitura,
      atualização, exclusão, disparo manual de sondagem e uso da reserva de
      descoberta.
  - name: health
    description: Relatório de saúde e prontidão do serviço.
paths:
  /v1/health:
    get:
      tags:
        - health
      summary: Relatório de saúde agregado
      description: >-
        Executa cada verificador de saúde registrado (conectividade com o BACEN,
        validade do certificado TLS, expiração de credenciais, heartbeat do
        worker, líder do scheduler, orçamento de taxa, estado da licença),
        agrega-os em modo worst-of e retorna o relatório estruturado. O status
        HTTP espelha o agregado: healthy=200, warning=207 (Multi-Status),
        critical=503. Uma falha na fonte do relatório retorna 503 com um corpo
        de erro de produto estruturado.
      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

````