Skip to main content
PUT
Set this tenant's outbound Dataprev rail throughput

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

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.

Exemplo:

"idem-1"

Corpo

application/json
requestsPerSecond
integer<int64>
obrigatório

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.

Exemplo:

10

Resposta

OK

configured
boolean
obrigatório

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.

Exemplo:

false

maximumRequestsPerSecond
integer<int64>
obrigatório

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.

Exemplo:

25

requestsPerSecond
integer<int64>
obrigatório

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

Exemplo:

3

starterRequestsPerSecond
integer<int64>
obrigatório

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

Exemplo:

3