Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ DOC ] Incorrect kwarg in doc for 'perform_policies_action' method when editing rule groups. #1182

Closed
2 of 3 tasks
api-clobberer opened this issue Jun 9, 2024 · 1 comment
Assignees
Labels
documentation 📖 Improvements or additions to documentation prevention policies Prevention Policies issues and questions

Comments

@api-clobberer
Copy link

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:

  • GitHub Wiki
  • falconpy.io
  • Source code - docstring
@api-clobberer api-clobberer added the documentation 📖 Improvements or additions to documentation label Jun 9, 2024
@api-clobberer api-clobberer changed the title [ DOC ] ... [ DOC ] Incorrect kwarg in doc for 'perform_policies_action' method when editing rule groups. Jun 14, 2024
@jshcodes jshcodes self-assigned this Jun 28, 2024
@jshcodes jshcodes added the prevention policies Prevention Policies issues and questions label Jun 28, 2024
@jshcodes
Copy link
Member

jshcodes commented Aug 5, 2024

Resolved and replicated to falconpy.io.

Thank you for reporting this issue!

@jshcodes jshcodes closed this as completed Aug 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📖 Improvements or additions to documentation prevention policies Prevention Policies issues and questions
Projects
None yet
Development

No branches or pull requests

2 participants