API reference · Rulesets
Create a validated ruleset
POST/v1/orgs/{org}/rules
- Permission
rules.rulesets.manage- Request body
- at most 1,048,576 bytes
- Audit log
rules.ruleset.create- Operation
rules.rulesets.create
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 |
|---|
name | string | yes | 1 to 100 characters |
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 |
Response 201
| 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. |