Skip to navigation
API ReferenceQuotas

Set global quotas

Replace the cluster-wide resource quota configuration. The new configuration is propagated to every peer through consensus and persisted, so it survives restarts

Authentication

api-keystring

Authorization key, either read-write or read-only

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

waitbooleanOptionalDefaults to false

If true, wait until the new configuration is confirmed by consensus on this peer. If false - the request returns as soon as the change is proposed.

Request

Quota configuration to apply
enabledbooleanOptionalDefaults to false
Whether the limits below are enforced.
max_resident_memory_percentinteger or nullOptional1-100

Reject memory-consuming updates once process resident memory reaches this percentage of total system memory (or of the cgroup limit, if one applies).

max_disk_usage_percentinteger or nullOptional1-100

Reject disk-consuming updates once the filesystem hosting the storage directory is filled to this percentage of its capacity.

release_margin_percentinteger or nullOptional0-100

How many percentage points below its limit a resource has to fall before this node starts accepting work again.

Without a margin, a resource resting on its limit crosses it in both directions on the noise between two readings, putting the node in and out of service each time — and restarting a shard recovery with it. Raise it where usage is volatile; 0 disables the margin and releases as soon as usage is back under the limit.

Unset leaves the built-in default in force, so a config written today does not pin a number that a later release may want to revise.

Response

successful operation
usageobject or anyOptional
timefloatOptional
Time spent to process this request
statusstringOptional
resultbooleanOptional

Errors

4XX
Client Request Error