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

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Body

application/json
requestsPerSecond
integer<int64>
required

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.

Example:

10

Response

OK

configured
boolean
required

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.

Example:

false

maximumRequestsPerSecond
integer<int64>
required

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.

Example:

25

requestsPerSecond
integer<int64>
required

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

Example:

3

starterRequestsPerSecond
integer<int64>
required

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

Example:

3