Guides
  1. Integrations

Rapid7 Vulnerability Management Integration

🚧

Prerequisites

Any user can generate a user key. A user key will inherit your account’s permissions, so anything you can do, your API key can do.

  • Platform Administrators can generate, view, and manage API keys across all organizations.
  • Organization Administrators can do the same but only within their assigned organization.
  • Users can generate and manage their own API keys.

Authentication Methods

Rapid7 VM supports two authentication methods depending on which API version you're using. However, you will need to generate an API Key and obtain your v4 Cloud Base URL and your v3 Console Base URL in order for the integration to work properly.

API Key Authentication (Recommended - v4 API)

Generating a Rapid7 VM API Key

  1. Log into your Rapid7 account at https://insight.rapid7.com.

  2. Navigate to Administration from the left-hand sidebar.


  1. Click API Key Management.


  1. Choose one of the following:

    1. New User Key: If you’re a regular user.


    1. New Organization Key: If you’re a Platform or Organization Administrator.


  1. In the panel that appears:

    1. Select the organization (if applicable).
    2. Enter a descriptive name for the key.
    3. Click Submit.

  1. Copy the API key from the popup. This is the only time it will be visible.


  1. Click Done.

❗️

Warning

You must copy the API key immediately after generating it. You won't be able to retrieve it again later.


🚧

Important

Console credentials are separate from your Insight Platform login. These are local accounts specific to the InsightVM Console instance.



Add Configuration

  1. Navigate to the Integrations tab using the left-hand menu, find Integration Name, and select +Add Configuration.


  1. Next, fill in the details below and select Continue.


    v4 Cloud Base URL: Choose your region from the drop-down menu:

    • US: https://us.api.insight.rapid7.com
    • US2: https://us2.api.insight.rapid7.com
    • US3: https://us3.api.insight.rapid7.com
    • EU: https://eu.api.insight.rapid7.com
    • CA: https://ca.api.insight.rapid7.com
    • AU: https://au.api.insight.rapid7.com
    • AP: https://ap.api.insight.rapid7.com

    Name: Enter the name of the integration.

    is Enabled: Toggle button to ensure data is populated into Compyl.

    Key: The API Token you generated above.


  1. Choose your Endpoints and Begin Validation to validate your connection.


  1. Select any Blueprints you wish to associate with this integration.


  1. After you hit Continue, you'll see a summary screen. Click Return to Integrations to complete the configuration.


Once you have completed filling out the form click Return to Integrations.

You'll know the integration is successfully added when the status updates to Complete.


Data is synced on a recurring schedule configured by your Compyl administrator. Each sync pulls the latest data from all enabled endpoints.

To query the data from the integration, refer to the Blueprints article.


Updated 2 months ago

Did this page help you?