API reference · Rulesets
Check a ruleset without saving it
POST/v1/orgs/{org}/rules/check
- Permission
rules.rulesets.manage- Request body
- at most 1,048,576 bytes
- Audit log
rules.ruleset.check- Operation
rules.rulesets.check
Parameters
| Name | In | Type | Required | Notes |
|---|
org | path | string | yes | for example "org_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 |
|---|
phase | string | yes | one of "access", "rate_limit" |
languageVersion | 1 | yes | |
rules | array of object or object | yes | 0 to 64 items |
Response 200
| Field | Type | Required | Notes |
|---|
rules | array of object | yes | 0 to 64 items |
rules[].issues | array of object | yes | 0 to 20 items |
rules[].issues[].line | integer | yes | 1 to ∞ |
rules[].issues[].column | integer | yes | 1 to ∞ |
rules[].issues[].message | string | yes | |
rules[].estimatedCost | integer | yes | 0 to 10000 |