Add new API source

This document is for Invicti Platform

Invicti Platform can integrate with multiple API sources for discovering and importing your existing APIs into your Invicti API Inventory.

This document explains how to add a new API source to Invicti Platform.

To add a new API source, you can use one of the following options:

• Add a new source from an external platform.
• Add a new source from a file.

Add a new API source from an external platform

1. Select Discovery > Configuration from the left-side menu.
2. Navigate to section API sources and click Add new source button to open configuration.
3. Select External platform.

4. Input the name for your source. In this example, enter New API Source.

5. Keep the toggle on by Exclude empty specifications to exclude APIs that don't contain any defined endpoints.

6. Select the source type. Where required, enter the information from your API source and follow the on-screen instructions:

   • Invicti Network Traffic Analyzer (NTA) with Istio Mesh Service or NTA with Tap Plugin
   • Apigee API hub
   • Amazon API Gateway
   • MuleSoft Anypoint Exchange
   • Azure API Management
   • Kong Konnect

Add a new API source from a file

1. Select Discovery > Configuration from the left-side menu.
2. Navigate to section API sources and click Add new source button to open configuration.
3. Select From File.

4. In the Name field, type the name of your source, for example New API Source.
5. In the Base URL enter the root URL of the API endpoints. For example, if your page is http://example.com, the base API URL could be: http://example.com/api/v1.
6. In the API specification field, upload the file in .json, .yaml, or .raml format.
7. In the Type drop-down, select the type of your file: OpenAPI 2.x (Swagger2), OpenAPI 3.x, or RAML.
8. Click Save to finish the configuration.

Need help?

Invicti Support team is ready to provide you with technical help. Go to Help Center