v1

latestOpenAPI 3.0.2Mozilla Public License 2.02026-07-17307105155.2 KB
system

post/sys/quotas/rate-limit/{name}

Request body

block_intervalinteger

If set, when a client reaches a rate limit threshold, the client will be prohibited from any further requests until after the 'block_interval' has elapsed.

intervalinteger

The duration to enforce rate limiting for (default '1s').

pathstring

Path of the mount or namespace to apply the quota. A blank path configures a global quota. For example namespace1/ adds a quota to a full namespace, namespace1/auth/userpass adds a quota to userpass in namespace1.

ratenumber float

The maximum number of requests in a given interval to be allowed by the quota rule. The 'rate' must be positive.

rolestring

Login role to apply this quota to. Note that when set, path must be configured to a valid auth method with a concept of roles.

typestring

Type of the quota rule.

Response

OK