> ## 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. # Set this tenant's outbound Dataprev rail throughput > Sets the tenant's own outbound Dataprev rail rate, within the rail's 0..25 contract. A value outside that range is refused naming the rejected value; zero is accepted and pauses this tenant's outbound rail. Setting the value the tenant already holds succeeds without recording a transition. The change is durable and published as one fact; the serving replica applies it on its very next exchange, and every other replica converges within the pace cache TTL. ## OpenAPI ````yaml en/openapi/v3-current/consignado.yaml put /v1/consignado/throughput openapi: 3.1.0 info: contact: email: contact@lerian.studio name: Lerian Studio url: https://lerian.studio description: >- OpenAPI 3.1 surface for Lerian Consignado — Dataprev. The API covers tenant credentials and rail configuration, worker margin, loan auctions and bids, contract registration and lifecycle, disbursement confirmation, portability, refinancing, renegotiation, FGTS guarantees, reconciliation, funds, assignments, usage, throughput, and event subscriptions. Secret material is written to the tenant secret store and is never returned by any operation. 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: >- Per-tenant Dataprev credential custody and public rail configuration (upload, status, rotation, revoke, requester code, and worker portal base URL) name: Credentials - description: >- Tenant-scoped consignado gateway usage: priced billable-unit aggregation per competência name: Consignado Usage - description: >- Per-tenant streaming-hub subscription control-plane (list, create, get, rotate, revoke, and test delivery) name: Subscriptions - description: >- Dataprev payroll-rail surface: FGTS balance and authorization reads, the FGTS guarantee execution, contract suspension, reactivation and term changes, the rail's own contract documents, and the on-demand reads of leilão solicitações, escriturações, repasses and employment terminations name: Consignado Rail - description: >- Synchronous rail command surface: the operations a bancarizador without the lender drives over HTTP. Each shares its command implementation with the equivalent lender event trigger. name: Consignado Rail Commands - description: >- Gateway-owned disbursement confirmation: a client bank recording money it has ALREADY paid to a worker. It crosses no government boundary and proxies no Dataprev operation. name: Consignado Disbursement - description: >- Per-tenant self-service outbound Dataprev rail throughput: read and set this tenant's own requests-per-second, including a deliberate pause at zero name: Consignado Throughput paths: /v1/consignado/throughput: put: tags: - Consignado Throughput summary: Set this tenant's outbound Dataprev rail throughput description: >- Sets the tenant's own outbound Dataprev rail rate, within the rail's 0..25 contract. A value outside that range is refused naming the rejected value; zero is accepted and pauses this tenant's outbound rail. Setting the value the tenant already holds succeeds without recording a transition. The change is durable and published as one fact; the serving replica applies it on its very next exchange, and every other replica converges within the pace cache TTL. operationId: putConsignadoThroughput requestBody: content: application/json: schema: $ref: '#/components/schemas/PutThroughputRequest' required: true 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: PutThroughputRequest: additionalProperties: false properties: requestsPerSecond: description: >- The outbound Dataprev rail rate to set for this tenant, in requests per second, within the rail's 0..25 contract. Zero is a deliberate self-service pause and stops this tenant's outbound rail; it is accepted, not refused. Setting the value the tenant already holds succeeds without recording a transition. examples: - 10 format: int64 type: integer required: - requestsPerSecond type: object 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: -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 ````