API reference · Rulesets
Read a zone's rate-limit ruleset and what its pool applied
GET
/v1/orgs/{org}/zones/{zone}/rate-limits- Permission
rules.rulesets.read- Operation
rules.rateLimits.get
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
org | path | string | yes | for example "org_01h455vb4pex5vsknk084sn02q" |
zone | path | string | yes | for example "zone_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" |
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. |