Rules
List rule sets
See the rule sets your agents are checked against.
How it works
You get every rule set one of your agents is bound to now, sorted by name, with the agents bound to it. A rule set that is switched off isn’t listed.
A finding or result can name a rule set that none of your agents is bound to any more. This list doesn’t include it, so show the finding’s own rule_set_name instead.
Request body
application/json
- agent_idstring
Only this agent’s rule sets.
- rule_set_idsstring[]up to 100
Only these rule sets.
- limitintegerdefault 25up to 100
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 rule sets. An empty list if there are none.
- dataobject[]required
One entry per rule set.
- idstring (uuid)required
The rule set’s ID. Other endpoints call this
rule_set_id. - namestringrequired
Its name.
- source_typestringrequired
Where its rules come from.
regulationframeworkcontractunknown - agent_idsstring[]required
The agents bound to it.
- 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_request.
The API key is missing, wrong, revoked or expired.
Returns an error, for example with the code authentication_failed.