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.

PUT /v1/consignado/throughput

Set this tenant's outbound Dataprev rail throughput

cURL

curl --request PUT \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/consignado/throughput \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "requestsPerSecond": 10
}
'

200

{
  "configured": false,
  "maximumRequestsPerSecond": 25,
  "requestsPerSecond": 3,
  "starterRequestsPerSecond": 3
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency · string

Optional idempotency key. Sent again with the SAME body, the stored response is replayed and the chain records one transition; sent again with a DIFFERENT body, the request is refused with 422 because the key was already spent on another intent. Absent, the request executes once, exactly as it always has.

Ejemplo:

"idem-1"

Cuerpo

application/json

requestsPerSecond · integer<int64> · requerido

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.

Ejemplo:

10

Respuesta

200

application/json

OK

configured · boolean · requerido

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.

Ejemplo:

false

maximumRequestsPerSecond · integer<int64> · requerido

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.

Ejemplo:

25

requestsPerSecond · integer<int64> · requerido

This tenant's outbound Dataprev rail rate, in requests per second. Zero is a deliberate self-service pause, not an absent value.

Ejemplo:

3

starterRequestsPerSecond · integer<int64> · requerido

The floor a tenant paces at before it has chosen anything.

Ejemplo:

3