Rules
List rules
See the rules Ollive checks your agents against.
How it works
You get the rules in the rule sets your agents are bound to now, by rule set and then by ID: what each rule asks of your agent, where it comes from, and how serious it is.
A rule’s id is the rule_id the other endpoints take. Findings, finding runs and results include the same rule, as rule.
If your agents use different versions of a rule set, a rule shows its newest version. Set agent_id to see the version that agent uses.
Request body
application/json
- rule_set_idstring (uuid)
Only this rule set’s rules.
- agent_idstring
Only the rules of this agent’s rule sets.
- rule_idsstring[]up to 100
Only these rules.
- limitintegerdefault 50up to 200
How many to return per page.
- cursorstring
The
next_cursorfrom the previous page. - include_totalboolean
Also return
total_count, the number of matches across all pages. Counting takes extra time, so ask only when you show it.
Response
The rules. An empty list if there are none.
- dataobject[]required
One entry per rule.
- idstringrequired
The rule’s ID. Other endpoints call this
rule_id. - rule_set_idstring (uuid)
The rule set it belongs to.
- severitystringrequired
How serious it is.
unknownwhen the rule has no rating.criticalhighmediumlowunknown - citationsstring[]required
Where the rule comes from, such as a section number.
- textstring
What the rule asks of your agent.
- titlestring
A short name for the rule, when its rule set gives one.
- descriptionstring
A longer explanation, when its rule set gives one.
- total_countinteger
How many match, across all pages. Only with
include_total. - has_morebooleanrequired
Whether there is another page.
- next_cursorstring
Send this as
cursorto get the next page. Not included on the last page.
Something in the request is wrong. code and param tell you what.
Returns an error, for example with the code invalid_cursor.
The API key is missing, wrong, revoked or expired.
Returns an error, for example with the code authentication_failed.