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

Added Rapid7 ThreatCommand workflow Signed-off-by: Benimanela [email protected] #167

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Benimanela
Copy link

Added Rapid7 ThreatCommand workflow Signed-off-by: Benimanela [email protected]

@ChrisCollinsIBM ChrisCollinsIBM added the workflow-submission Issue linked to a pull request for a workflow submission label May 27, 2024
Copy link
Contributor

@ChrisCollinsIBM ChrisCollinsIBM left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything looks great overall, I made a few small comments you can have a look at but nothing that would stop this from being merged.

Feel free to resolve any of those threads by addressing it or commenting and marking them as resolved and I'll get this merged.

Thanks for the submission!

<CallEndpoint url="${/hostname}/public/v2/data/alerts/alerts-list" method="GET" savePath="/get_alert_list" >
<BasicAuthentication username="${/account_id}" password="${/api_key}" />
<QueryParameter name="isClosed" value="${/is_closed}" />
<QueryParameter name="severity" value="${/severity}" />
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this parameter isn't required, you may want to consider setting omitIfEmpty=true so the parameter isn't included in the <CallEndpoint> if the value is just empty.

# Rapid& ThreatCommand Parameters Configuration
Parameter | Name | Default Value | Type | Required (True/False) | Description
--- | --- | --- | --- |--- |---
hostname | Host Name | https://api.ti.insight.rapid7.com | String | True | IP or URL for the instance.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this API use regional endpoints as outlined here - https://docs.rapid7.com/insight/product-apis/#supported-regions

These endpoints may have changed since this workflow was submitted, but just wanted to see if there's maybe a list worth providing to end users to make sure they use the correct endpoint for their region if appropriate.

</If>

<!-- Initialize a list to contain all alerts -->
<Set path="/alerts" value="[]" />
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this API support paging? If so this will only get the first page of data and then more pages on subsequent runs.

Often with Alert based integrations this is usually fine but just wanted to probe that point.

Copy link
Contributor

@ChrisCollinsIBM ChrisCollinsIBM left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the submission, I had added comments back in July but forgot to include them as part of a review.

If you could comment or address some of the review topics that would be great, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
workflow-submission Issue linked to a pull request for a workflow submission
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants