> ## Documentation Index
> Fetch the complete documentation index at: https://docs.leen.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Rapid7 InsightVM Vulnerability Management Instructions

> Instructions on how to generate credentials for Rapid7's InsightVM Vulnerability Management platform and the required permissions.

For Leen to authenticate with Rapid7 InsightVM, we require the following:

1. **Base URL**: The Base URL or the Base Path for the Rapid7 InsightVM API. This is in the format: `https://{region}.api.insight.rapid7.com`.
2. **API Key**: A unique API Key tied to an Organization in Rapid7. In the following section, we will cover how to create a new API key with the required scopes.

<Warning>InsightVM **must** be connected to Rapid7's Insight Cloud Platform, you can refer to the [official Rapid7 documentation](https://docs.rapid7.com/insightvm/activating-your-console-on-the-insight-platform).</Warning>

### Permissions and User setup

Due to restrictions with Rapid7's API, an Organization Level API Key is required.

Here is how you can create a new Organization Level API Key:

<Steps>
  <Step title="Company Settings">
    In the Rapid7 console, navigate to 'Company Settings'.

    <img src="https://mintcdn.com/leen/v5iddL0dhlngJwjt/images/rapid7/company-settings.png?fit=max&auto=format&n=v5iddL0dhlngJwjt&q=85&s=5722b10c4af63a0e58dee2d0197e073b" alt="" width="1921" height="974" data-path="images/rapid7/company-settings.png" />
  </Step>

  <Step title="Generate a Key">
    Navigate to 'API Key Management' and choose 'Organization Keys'. Click on the **Generate New Organization Key** button.

    <img src="https://mintcdn.com/leen/v5iddL0dhlngJwjt/images/rapid7/organization-keys.png?fit=max&auto=format&n=v5iddL0dhlngJwjt&q=85&s=6b94e13bf5bd73ac1871ec71ea1a2765" alt="" width="3836" height="1866" data-path="images/rapid7/organization-keys.png" />
  </Step>

  <Step title="Configure your Key">
    Next, you will tie your key to an Organization in your Rapid7 environment and name it.

    <img src="https://mintcdn.com/leen/v5iddL0dhlngJwjt/images/rapid7/key-configuration.png?fit=max&auto=format&n=v5iddL0dhlngJwjt&q=85&s=54ae7a4fe0d64636cf210abc10c78d77" alt="" width="1922" height="973" data-path="images/rapid7/key-configuration.png" />
  </Step>

  <Step title="Save your API Key">
    Once you click Submit, you should see the API Key generated. Copy this API Key and store it securely.

    <img src="https://mintcdn.com/leen/v5iddL0dhlngJwjt/images/rapid7/api-key.png?fit=max&auto=format&n=v5iddL0dhlngJwjt&q=85&s=b29cd09328534f8827712483bbea60cf" alt="" width="606" height="278" data-path="images/rapid7/api-key.png" />
  </Step>
</Steps>

For more information on how to create an API Key, you can refer to the [official Rapid7 documentation](https://docs.rapid7.com/insight/managing-platform-api-keys/).
