This integration provides the following benefits:
- Validate that security tools are writing log events to Rapid7 InsightIDR to ensure compliance with security policies and regulations
- Collect events generated by security tools that write to Rapid7 InsightIDR to test the efficacy and configuration of security controls using Security Validation jobs
API Calls
| API | Usage |
|---|---|
/query/logsets |
Query InsightIDR for events |
Supported Versions
Insight IDR Cloud
Before You Begin
To configure this integration, you need A Rapid7 API Key.
Generate a User API Key
- Log in to your Insight account
- Navigate to the API Keys page
- Click the New User Key button. The New User Key panel appears
- Select an organization and enter a name for the key
- Generate the key. A new window opens displaying the generated key
- Copy the key and paste it to a safe location for use in the integration configuration. You will not be able to view the key again after you close the window
Configure the Integration in Security Validation
-
Go to Settings > Integrations.
- From the Integrations table, click Add Integration > Rapid7 InsightIDR.
You can add this as either a Direct or Remote Integration.
- Enter a meaningful Integration Name.
- Optional: From the Proxy drop-down, choose a proxy profile if one is available. If one isn't available and all outbound connections go through a proxy, first, set up a Proxy Rule.
- Change the HttpProtocols to use for requests. (Https or Http.)
- For the Host, change the value if needed. The default is us.rest.logs.insight.rapid7.com.
- Enter a Port value. The default is 443.
- Enter the Api Key value that you generated.
- Optional: Check Verify Ssl if you want this verification done for requests to an upstream server.
- Optional: Change the Timeout value if you want a different frequency of requests to an upstream server. The default is 30 (seconds).
- Add values for Logsets. These typically correspond to an event type. For more information, see the Rapid7 InsightIDR logset documentation.
- Optional: Change Queries, if needed. A default value is provided.
- Optional: Modify the Field Map values, as necessary.
- Each field map box can hold a JSON-formatted comma-separated list of columns returned by the API to be considered for each field when translating into the normalized event object format. Example: description could be configured to be 'msg_s' or 'SyslogMessage' in some environments. The field map tries both if set to: ['msg_s','SyslogMessage'] and whichever matches first is the column that is used.
- When configuring an integration in Security Validation, you can assign additional host values in the Field Map settings. If none of the assigned fields return a valid host name, Network Actions may miss matched events from the third-party technology. Additional hosts values helps ensure the likelihood of a match between the two environments.
-
Optional: Modify the Page Size value for requests to the upstream server. The default is 500.
-
Optional: Expand Advanced options and update the information as necessary.
- Update Query Time and Delay Time.The Query time is the amount of time (minutes) before and after the query runs that the platform looks for events, while the Delay time is the amount of time (minutes) that the platform waits to run the first query after a Job Action starts. For example, you configure your integration with the following values: Query time = 5, Query interval = 30 seconds, and Delay time = 0. When a Job Actions starts at 12:00:00, the first time the query runs, the platform looks for events from 11:55:00 to 12:00:00. Then 30 seconds later, it looks for events from 11:55:30 to 12:00:30. This interval continues, with the last query looking from 12:00:00 to 12:05:00. If you instead configured the Delay time to equal 10, it would run the same query, but it wouldn't start that query until 12:10:00.If your monitors are set to run more frequently than the query time, this configuration impacts the pass/fail results for AEDA monitors.
- Update Query Interval (seconds).
- If supported by your integration, configure correlation queries:
- Select Correlation Query Enabled and fill in the Correlation Query.
- Modify the Correlation Query Interval, if necessary (minutes).
- Select
Discover network devices automatically, the default and recommended option.If unselected, reported events won't include product information for any matching network security technology.
- Select Save Suspicious Events.
- Modify the Event Time Adjustment (seconds). The default is 0.
Modify the Limit value if you need to prevent a flood of results. This value is set to 10000 by default. This limit applies to both events and alerts individually, so if you set it to 10, you can still see a maximum of 10 events and 10 alerts.
- Update Query Time and Delay Time.
-
Click Save.
Verify connectivity
- Go to Settings > Integrations.
- From the Direct Integrations table, click
> Test to verify that:
- The Director can communicate with the integration host on the port and protocol specified.
- The integration credentials are valid and working.
For more information on setting up queries, see Manage Integrations.