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

# Obtenga el rendimiento de red saliente Dataprev de este tenant

> Devuelve la propia velocidad de red saliente Dataprev del tenant en solicitudes por segundo, junto con el techo bloqueado por código de la red y el piso inicial, de modo que ningún consumidor reexprese ninguno de los números de su propio paquete. Un tenant que nunca ha elegido una tarifa se reporta en el piso inicial con configured=false; la lectura nunca abre una cadena. Una tasa de cero es una pausa deliberada de autoservicio, nunca un valor ausente.



## OpenAPI

````yaml es/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: >-
    Superficie OpenAPI 3.1 para Lerian Consignado — Dataprev. API cubre las
    credenciales y la configuración de red de tenant, el margen de los
    trabajadores, las subastas y ofertas de préstamos, el registro y el ciclo de
    vida de los contratos, la confirmación de desembolsos, la portabilidad, la
    refinanciación, la renegociación, las garantías de FGTS, la conciliación,
    los fondos, las asignaciones, el uso, el rendimiento y las suscripciones a
    eventos. El material secreto se escribe en el almacén secreto tenant y
    ninguna operación lo devuelve nunca.
  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: >-
      Custodia de credenciales de Dataprev y configuración pública del rail por
      tenant (carga, estado, rotación, revocación, código del solicitante y URL
      base del portal del trabajador)
    name: Credentials
  - description: >-
      Uso de la gateway del consignado en el ámbito del tenant: agregación de
      unidades facturables con precio por competencia
    name: Consignado Usage
  - description: >-
      Plano de control de suscripción al hub de streaming per-tenant (enumerar,
      crear, obtener, rotar, revocar y probar la entrega)
    name: Subscriptions
  - description: >-
      Superficie de rail de nómina Dataprev: lecturas de saldo y autorización
      FGTS, ejecución de garantía FGTS, suspensión de contrato, reactivación y
      cambios de términos, documentos de contrato propios de la red y lecturas
      bajo demanda de leilão solicitações, escriturações, repasses y
      terminaciones de empleo.
    name: Consignado Rail
  - description: >-
      Superficie de comando de red síncrona: las operaciones de un bancarizador
      sin que el prestamista conduzca sobre HTTP. Cada uno comparte su
      implementación de comando con el activador de evento de prestamista
      equivalente.
    name: Consignado Rail Commands
  - description: >-
      Confirmación de desembolso propiedad de la gateway: un banco cliente que
      registra el dinero que ya pagó a un trabajador. No cruza ninguna frontera
      gubernamental y no representa ninguna operación Dataprev.
    name: Consignado Disbursement
  - description: >
      Rendimiento de red Dataprev saliente de autoservicio per-tenant: lea y
      configure el requests-per-second propio de este tenant, incluida una pausa
      deliberada en cero
    name: Consignado Throughput
paths:
  /v1/consignado/throughput:
    get:
      tags:
        - Consignado Throughput
      summary: Obtenga el rendimiento de red saliente Dataprev de este tenant
      description: >-
        Devuelve la propia velocidad de red saliente Dataprev del tenant en
        solicitudes por segundo, junto con el techo bloqueado por código de la
        red y el piso inicial, de modo que ningún consumidor reexprese ninguno
        de los números de su propio paquete. Un tenant que nunca ha elegido una
        tarifa se reporta en el piso inicial con configured=false; la lectura
        nunca abre una cadena. Una tasa de cero es una pausa deliberada de
        autoservicio, nunca un 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

````