get-rulesets
Get rulesets and their rules, from draft or active policy, rendered as data: scopes as [{key, value, href}], consumers/providers as {label: {key, value, href}} | {all_workloads: true} | {ip_list: {name, href}} | {label_group: {name…
Instructions
Get rulesets and their rules, from draft or active policy, rendered as data: scopes as [{key, value, href}], consumers/providers as {label: {key, value, href}} | {all_workloads: true} | {ip_list: {name, href}} | {label_group: {name, href}}, ingress_services as {port, proto} or {service: {name, href}}. Allow, deny and override_deny rules share one shape (rule_type). labels matches ruleset SCOPE; actor_labels returns only the rules that NAME those labels as consumer or provider, in any ruleset -- 'the policy that touches app X'. Each ruleset costs one extra request for its deny rules, so filter where you can.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Filter rulesets by name (supports partial matches) | |
| labels | No | Scope filter: key=value or label HREFs, ANDed (['app=shop', 'env=prod'] = rulesets scoped to exactly that app). A pre-encoded JSON string is still accepted. | |
| enabled | No | Filter by enabled/disabled status | |
| pversion | No | Policy version to read (default draft). Echoed as policy_version. | |
| actor_side | No | Which side actor_labels must appear on (default any) | |
| description | No | Filter rulesets by description (supports partial matches) | |
| max_results | No | Maximum number of rulesets to return | |
| actor_labels | No | Return only rules whose consumers or providers reference ALL of these labels (key=value or HREF). Rulesets with no matching rule are omitted. |