API reference · Rulesets
Read the current validated ruleset version
GET
/v1/orgs/{org}/rules/{ruleset}- Permission
rules.rulesets.read- Operation
rules.rulesets.get
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
org | path | string | yes | for example "org_01h455vb4pex5vsknk084sn02q" |
ruleset | path | string | yes | for example "rul_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 |
|---|---|---|---|
id | string | yes | for example "rul_01h455vb4pex5vsknk084sn02q" |
orgId | string | yes | for example "org_01h455vb4pex5vsknk084sn02q" |
name | string | yes | |
revision | string | yes | |
definition | object | yes | |
definition.phase | string | yes | one of "access", "rate_limit" |
definition.languageVersion | 1 | yes | |
definition.rules | array of object or object | yes | 0 to 64 items |
estimatedCosts | array of integer | yes | 0 to 64 items |
createdAt | string (date-time) | yes | UTC, ISO 8601. |
updatedAt | string (date-time) | yes | UTC, ISO 8601. |