Skip to main content

​
Generate Rapid 7 API & Setup Deployment Region

You will need an API key to interact with the Rapid7 InsightAppSec API.
1

Access Rapid7 Insight Platform

  1. Go to the Rapid7 Insight Platform.
  2. Click on the gear icon (⚙️) at the page’s top right corner.
  3. From the dropdown menu, select “API Keys”.
  4. Choose the Type of API Key (User Key or Organization Key) to Generate:
    • User Key: Represents your user account and inherits your account’s permissions. All users can generate a User Key.
    • Organization Key: This key represents the entire organization and provides comprehensive access across all products. Only platform or organization administrators can generate an Organization Key.
  5. Click Generate.
    • For a User Key:​
      • Click on “New User Key.”
      • In the “Generate New User Key” panel, select your organization and provide a descriptive name for the key.
      • Click “Generate”.
    • For an Organization Key:​
      User must have Admin/Super Admin access to create Organization Key.
      • Click on the “Organization Keys” tab.
      • Click “New Organization Key.”
      • In the “Generate New Organization Key” panel, select the organization and provide a descriptive name for the key.
      • Click “Generate”.
    Copy and securely save the generated API token (it won’t be shown again).
2

Determine Data Storage Region

Each region has specific endpoints that your network must communicate with.
Ensure your network allows outbound connectivity to these hostnames over TCP port 443.
RegionWeb DataDeployment EndpointAPI EndpointS3 (Agent Downloads)
United States - 1exposure-analytics.insight.rapid7.comus.deployment.endpoint.ingress.rapid7.comus.api.endpoint.ingress.rapid7.coms3.amazonaws.com
United States - 2us2.exposure-analytics.insight.rapid7.comus2.deployment.endpoint.ingress.rapid7.comus2.api.endpoint.ingress.rapid7.coms3.us-east-2.amazonaws.com
United States - 3us3.exposure-analytics.insight.rapid7.comus3.deployment.endpoint.ingress.rapid7.comus3.api.endpoint.ingress.rapid7.coms3.us-west-2.amazonaws.com
Canadaca.exposure-analytics.insight.rapid7.comca.deployment.endpoint.ingress.rapid7.comca.api.endpoint.ingress.rapid7.coms3.ca-central-1.amazonaws.com
Europeeu.exposure-analytics.insight.rapid7.comeu.deployment.endpoint.ingress.rapid7.comeu.api.endpoint.ingress.rapid7.coms3.eu-central-1.amazonaws.com
Japanap.exposure-analytics.insight.rapid7.comap.deployment.endpoint.ingress.rapid7.comap.api.endpoint.ingress.rapid7.coms3.ap-northeast-1.amazonaws.com
Australiaau.exposure-analytics.insight.rapid7.comau.deployment.endpoint.ingress.rapid7.comau.api.endpoint.ingress.rapid7.coms3.ap-southeast-2.amazonaws.com
3

Associate the UUID with Your API Key

Since Rapid7 does not natively provide UUIDs for API keys, you can:
  • Store the API key and UUID mapping in your internal configuration files or database.
  • Use the UUID as an identifier when logging API calls for tracking purposes.
To get the UUID of an asset, use the following API call:

curl --location 'https://{region}.api.insight.rapid7.com/idr/v2/investigations' \
--header 'X-Api-Key: {API Key}' \
--header 'Content-Type: application/json'

​
Configure Slack in the AirMDR Integrations Dashboard

  1. Navigate to AirMDR, provide the credentials, and click Login.\ Duo7 Pn
  2. Navigate to the AirMDR Integrations Dashboard in the left navigation pane and select Integrations.
  3. Use the search option, enter the keyword “Rapid 7”, select the Connections tab, and click Create.\ Rapid71 Pn
  4. Enter the generated API token in the Authentication Details field params, and click Create.\ Rapid7 Pn