vPenTest API

NOTE  This feature is available to all vPenTest customers including MSP partners and internal IT teams.

Overview

The vPenTest API enables direct integration with your existing systems or internal tools, eliminating the need for manual platform interaction. Developers can easily connect vPenTest to internal tools and workflows by pulling data such as organizations, schedules, download URLs for all report types, and more.

Step 1: How to generate an API Key

• To generate an API key, click your Profile dropdown menu in the top right corner of the header, then click Generate API Key.
  
  

• Decide if you want the API to expire by a certain date or not expire at all.

• Then click Generate API Key.
  
  

• Once your API key is generated, make sure to copy it since we only display it once. You can generate a new one any time to safely replace the existing one.
  
  

Step 2: View API Swagger documentation

Once your API is generated, visit https://app.vpentest.io/api/v3/docs.