API reference · Rulesets
Bind an exact rate-limit ruleset version as the zone's rate limits
PUT/v1/orgs/{org}/zones/{zone}/rate-limits
- Permission
rules.rulesets.manage- Audit log
rules.rate_limits.update- Operation
rules.rateLimits.set
Parameters
| Name | In | Type | Required | Notes |
|---|
org | path | string | yes | for example "org_01h455vb4pex5vsknk084sn02q" |
zone | path | string | yes | for example "zone_01h455vb4pex5vsknk084sn02q" |
Idempotency-Key | header | string | no | One key per intended mutation. A retry with the key replays the recorded response instead of executing again; the key with another request answers 422 idempotency_key_reused. For example "01h455vb4pex5vsknk084sn02q" |
x-obhut-management-assignment | header | string | no | Select one staff assignment. Direct membership remains the default. Bound API tokens use their stored source and ignore this selector. For example "masg_01h455vb4pex5vsknk084sn02q" |
Request body
| Field | Type | Required | Notes |
|---|
ruleset | string | yes | for example "rul_01h455vb4pex5vsknk084sn02q" |
rulesetRevision | string | yes | |
revision | string | no | Opaque revision: dot-joined counters. |
Response 200
| Field | Type | Required | Notes |
|---|
zone | string | yes | for example "zone_01h455vb4pex5vsknk084sn02q" |
revision | string or null | yes | |
binding | object or null | yes | |
binding.ruleset | string | yes | for example "rul_01h455vb4pex5vsknk084sn02q" |
binding.rulesetRevision | string | yes | |
binding.updatedAt | string (date-time) | yes | UTC, ISO 8601. |
serving | object | yes | |
serving.state | string | yes | one of "ready", "pending", "stale", "failing", "empty_pool", "unknown", "unavailable" |
serving.ready | integer | yes | 0 to ∞ |
serving.total | integer | yes | 0 to ∞ |
serving.oldestReportAt | string (date-time) or null | yes | |
serving.checkedAt | string (date-time) | yes | UTC, ISO 8601. |