Getting Started

This set of documentation is for developing integrations (A.K.A. plugins) for the InsightConnect and legacy Komand SOAR (Security Orchestration, Automation, and Response) products.

Note: You can develop and test plugins, without owning the products, through our developer tools but you must have the products to orchestrate your plugins in a workflow.

Plugins that you develop can also be contributed to the Rapid7 Extension Library to be shared to the benefit of customers.

We have over 300 plugins, 250+ of which are available as open-source software on Github. Our open contribution model allows users to add and improve integrations for users.

Tooling

The standalone tooling is available below through Linux or MacOS packages and is compatible with InsightConnect or legacy Komand. The packages are the preferred installation method as they will keep your tooling current with ease.

Once the packages are installed, the binary is located at /usr/local/bin/icon-plugin.

Debian Linux

1
$ curl -s https://packagecloud.io/install/repositories/rapid7/insightconnect_plugin_tooling/script.deb.sh | sudo bash
2
3
$ sudo apt-get install icon-plugin

Enterprise Linux

1
$ curl -s https://packagecloud.io/install/repositories/rapid7/insightconnect_plugin_tooling/script.rpm.sh | sudo bash
2
3
$ sudo yum install icon-plugin

MacOS

1
$ brew tap rapid7/icon-plugin-homebrew https://github.com/rapid7/icon-plugin-homebrew
2
3
$ brew install icon-plugin

See the Plugin Tooling documentation for more information on using the tools.

Order

  1. Plugin Development Getting Started Videos
  2. Plugin Components
  3. Plugin Spec
  4. Running Plugins
  5. SDK Guide
  6. Regenerating Plugins
  7. Style Guide
  8. Error Handling in Integrations
  9. Troubleshooting
  10. User Interface
  11. Logo
  12. Unit Test Generation
  13. Unit Test Primer