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

# Obtenha a taxa de transferência de rail Dataprev de saída deste tenant

> Retorna a própria taxa de rail Dataprev de saída do tenant em solicitações por segundo, juntamente com o teto bloqueado por código da rede e o piso inicial, de forma que nenhum consumidor reafirme qualquer um dos números de seu próprio pacote. um tenant que nunca escolheu uma taxa é reportado no piso inicial com configured=false; a leitura nunca abre uma cadeia. uma taxa zero é uma pausa deliberada no autoatendimento, nunca um valor ausente.



## OpenAPI

````yaml pt/openapi/v3-current/consignado.yaml get /v1/consignado/throughput
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    Superfície OpenAPI 3.1 para Lerian Consignado — Dataprev. o API cobre
    credenciais tenant e configuração de rede, margem do trabalhador, leilões e
    licitações de empréstimos, registro e ciclo de vida do contrato, confirmação
    de desembolso, portabilidade, refinanciamento, renegociação, garantias FGTS,
    reconciliação, fundos, atribuições, uso, rendimento e assinaturas de
    eventos. o material secreto é gravado no armazenamento secreto tenant e
    nunca é devolvido por nenhuma operação.
  license:
    name: Lerian Studio General License
  title: Lerian Consignado API
  version: v1.0.0
servers:
  - url: https://consignado.sandbox.lerian.net
security:
  - BearerAuth: []
tags:
  - description: >-
      Custódia de credenciais do Dataprev e configuração pública do rail por
      tenant (upload, status, rotação, revogação, código do solicitante e URL
      base do portal do trabalhador)
    name: Credentials
  - description: >-
      Uso do gateway consignado no escopo do tenant: agregação de unidades
      faturáveis ​​com preço por competência
    name: Consignado Usage
  - description: >-
      Per-tenant plano de controle de assinatura do streaming-hub (listar,
      criar, obter, girar, revogar e testar a entrega)
    name: Subscriptions
  - description: >-
      Superfície folha de pagamento da rail Dataprev: leituras de saldo e
      autorização FGTS, execução de garantias FGTS, suspensão de contrato,
      reativação e alteração de prazo, documentos contratuais próprios da rede e
      leituras sob demanda de transações, escriturações, repasses e rescisões
      trabalhistas
    name: Consignado Rail
  - description: >-
      Superfície de comando da rede síncrona: as operações que um bancarizador
      sem o credor realizam sobre HTTP. cada um compartilha sua implementação de
      comando com o gatilho de evento de credor equivalente.
    name: Consignado Rail Commands
  - description: >-
      Confirmação de desembolso de propriedade do gateway: um banco cliente
      registrando o dinheiro que ALREADY pagou a um trabalhador. ele não cruza
      nenhuma fronteira governamental e não representa nenhuma operação
      Dataprev.
    name: Consignado Disbursement
  - description: >
      Taxa de transferência da rail Dataprev de saída de autoatendimento
      per-tenant: leia e defina o próprio requests-per-second deste tenant,
      incluindo uma pausa deliberada em zero
    name: Consignado Throughput
paths:
  /v1/consignado/throughput:
    get:
      tags:
        - Consignado Throughput
      summary: Obtenha a taxa de transferência de rail Dataprev de saída deste tenant
      description: >-
        Retorna a própria taxa de rail Dataprev de saída do tenant em
        solicitações por segundo, juntamente com o teto bloqueado por código da
        rede e o piso inicial, de forma que nenhum consumidor reafirme qualquer
        um dos números de seu próprio pacote. um tenant que nunca escolheu uma
        taxa é reportado no piso inicial com configured=false; a leitura nunca
        abre uma cadeia. uma taxa zero é uma pausa deliberada no
        autoatendimento, nunca um valor ausente.
      operationId: getConsignadoThroughput
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThroughputResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    ThroughputResponse:
      additionalProperties: false
      properties:
        configured:
          description: >-
            Whether this tenant has a throughput chain on record. False means
            the tenant has expressed nothing and is paced at the starter floor;
            it does NOT mean paused.
          examples:
            - false
          type: boolean
        maximumRequestsPerSecond:
          description: >-
            The ceiling the Dataprev rail imposes. It is code-locked: neither an
            operator nor a client can raise it. Read it from here rather than
            restating it.
          examples:
            - 25
          format: int64
          type: integer
        requestsPerSecond:
          description: >-
            This tenant's outbound Dataprev rail rate, in requests per second.
            Zero is a deliberate self-service pause, not an absent value.
          examples:
            - 3
          format: int64
          type: integer
        starterRequestsPerSecond:
          description: The floor a tenant paces at before it has chosen anything.
          examples:
            - 3
          format: int64
          type: integer
      required:
        - requestsPerSecond
        - configured
        - maximumRequestsPerSecond
        - starterRequestsPerSecond
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````