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

# Obtener el uso de la reserva de descubrimiento de entrada

> Proyecta el uso de la reserva de descubrimiento de entrada del tenant (reservado/usado/disponible qpm sobre la reserva configurada).



## OpenAPI

````yaml es/openapi/v3-current/sta.yaml get /v1/inbound-source-configs/budget
openapi: 3.0.3
info:
  title: Lerian STA API
  description: >-
    API de Lerian STA — el rail del lado del participante que conecta la
    institución con el sistema de intercambio de archivos STA (Sistema de
    Transferência de Arquivos) del Banco Central do Brasil. Cubre las
    transferencias de archivos salientes y entrantes, la gestión de credenciales
    de BACEN, la configuración del sondeo de fuentes entrantes y el trust-store
    del tenant para los certificados de firma de mensajes.
  version: v1.0.0
servers:
  - url: https://sta.sandbox.lerian.net
security:
  - BearerAuth: []
tags:
  - name: transfers
    description: >-
      Transferencias de archivos STA salientes y entrantes — creación, listado,
      lectura, cancelación, reintento y marcado de procesamiento urgente.
  - name: trust-store
    description: >-
      Ciclo de vida de los certificados X.509 del trust-store del tenant:
      listado, carga, eliminación y resumen de estado.
  - name: credentials
    description: >-
      Gestión de credenciales de BACEN STA: creación, lectura, actualización,
      rotación, revocación y prueba de conectividad.
  - name: inbound-source-configs
    description: >-
      Configuración del sondeo de fuentes entrantes: creación, lectura,
      actualización, eliminación, disparo manual de sondeo y uso de la reserva
      de descubrimiento.
  - name: health
    description: Reporte de salud y disponibilidad del servicio.
paths:
  /v1/inbound-source-configs/budget:
    get:
      tags:
        - inbound-source-configs
      summary: Obtener el uso de la reserva de descubrimiento de entrada
      description: >-
        Proyecta el uso de la reserva de descubrimiento de entrada del tenant
        (reservado/usado/disponible qpm sobre la reserva configurada).
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http.PollingBudgetView'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
components:
  schemas:
    http.PollingBudgetView:
      properties:
        inboundDiscoveryAvailableQpm:
          type: number
        inboundDiscoveryReservedQpm:
          type: number
        inboundDiscoveryUsedPercent:
          type: number
        inboundDiscoveryUsedQpm:
          type: number
        perCredential:
          description: >-
            PerCredential is the optional per-credential breakdown of the
            inbound

            discovery reserve usage. Each entry projects ONE credential against
            the

            per-credential ceiling; the top-level fields above remain the
            AGGREGATE.

            Additive: omitempty keeps the existing global-only response shape
            when no

            active inbound config carries a usable credential. Ordered by
            credentialId

            for deterministic output (the query service sorts upstream).
          items:
            $ref: '#/components/schemas/http.CredentialBudgetView'
          type: array
        status:
          type: string
      type: object
    http.CredentialBudgetView:
      properties:
        credentialId:
          type: string
        inboundDiscoveryAvailableQpm:
          type: number
        inboundDiscoveryReservedQpm:
          type: number
        inboundDiscoveryUsedPercent:
          type: number
        inboundDiscoveryUsedQpm:
          type: number
        status:
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      description: 'Bearer token authentication (format: "Bearer {token}")'
      in: header
      name: Authorization
      type: apiKey

````