[ DOC ] Incorrect kwarg in doc for 'perform_policies_action' method when editing rule groups. #1182
Closed
2 of 3 tasks
Labels
documentation 📖
Improvements or additions to documentation
prevention policies
Prevention Policies issues and questions
Documentation page topic
https://www.falconpy.io/Service-Collections/Prevention-Policy.html#performpreventionpoliciesaction
Describe the error or typo
When using 'action_parameters' under PreventionPolicies, the docs say group_id is the only available keyword that requires a value. If this doc is followed to use the endpoint to edit IOA rule groups with add-rule-group or remove-rule-group, the response is a 4XX error when providing the rule group's ID to the group_id keyword.
The fix is to use the keyword rule_group_id in place of the group_id keyword. Then, the endpoint returns a 2XX code and I can confirm that it adds the rule group to the policy specified with the ids keyword.
Documentation repository:
The text was updated successfully, but these errors were encountered: