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

# Get the inbound discovery reserve usage

> Projects the tenant's inbound discovery reserve usage
(reserved/used/available qpm over the configured reserve).



## OpenAPI

````yaml en/openapi/v3-current/sta.yaml get /v1/inbound-source-configs/budget
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/inbound-source-configs/budget:
    get:
      tags:
        - inbound-source-configs
      summary: Get the inbound discovery reserve usage
      description: |-
        Projects the tenant's inbound discovery reserve usage
        (reserved/used/available qpm over the configured reserve).
      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

````