Get this tenant's outbound Dataprev rail throughput

Returns the tenant’s own outbound Dataprev rail rate in requests per second, together with the rail’s code-locked ceiling and the starter floor, so no consumer restates either number from its own bundle. A tenant that has never chosen a rate is reported at the starter floor with configured=false; the read never opens a chain. A rate of zero is a deliberate self-service pause, never an absent value.

GET /v1/consignado/throughput

Get this tenant's outbound Dataprev rail throughput

cURL

curl --request GET \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/consignado/throughput \
  --header 'Authorization: Bearer <token>'

200

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

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

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