Getting Started

Creating a Collection

Before you can start an API Scan in ZeroThreat, you first need to create a Collection.

A Collection represents the source of your API endpoints and acts as the starting point for both unauthenticated and authenticated API scans. You can use it to scan public (unauthenticated) APIs right away, or later configure authentication for APIs that require it.

Here’s how you can create a collection in ZeroThreat.

Step 1: Create an API Target

First, you need to create a Target that defines the base URL of your API and sets the scan type.

  1. Go to the Targets section in ZeroThreat and click “Add Target.”
  2. Enter the Base URL of your API (e.g., https://api.example.com).
Thumbnail

  1. Under Scan Type, select API Scan and choose your preferred Scanning Server.
  2. Click “Save” to add the target.

Step 2: Add an API Collection to Your Target

Once your target is set up:

  1. From the ZeroThreat dashboard, select the API target you just created.
  2. Click on “Add API Collection.”
    This opens the Collection Drawer, where you’ll choose how to provide your API source.
Thumbnail

Step 3: Select Your API Source Type

ZeroThreat offers four options for importing your API collection:

Source TypeDescription
Swagger File / URLUpload a Swagger file or provide a public Swagger URL.
OpenAPI FileUpload an OpenAPI (OAS) YAML or JSON file.
Postman APIImport directly from a Postman collection.
HAR FileUpload a HAR (HTTP Archive) file from captured API traffic.

In this example, let’s choose Swagger File:

  • Select Swagger File from the source options.
  • Upload your Swagger file or paste the Swagger URL and click Fetch Collection.
Thumbnail

  • ZeroThreat will automatically parse the file and list all API endpoints.
Note:
ZeroThreat will only display endpoints that fall within your defined Target URL scope.
This ensures scans are limited to assets you own and control.

Step 4: Review and Configure API Endpoints

After parsing:

  • ZeroThreat will show all the API endpoints it found.
  • Some endpoints may have missing payloads or empty request bodies. (especially common with incomplete API specs).

Before saving:

  1. Review the list of endpoints.
  2. For any endpoint missing payloads or body parameters:
    • Provide sample data, payload values, or request bodies where required.
Thumbnail

APIs with missing request data cannot be fully tested. Adding this missing payload makes sure ZeroThreat can properly interact with your endpoints.
Thumbnail

Fill those API requests that have missing values in JSON with proper data. 3. Once everything is configured and reviewed: Click “Save”.

Your collection is now ready to use.
You can proceed to run an Unauthenticated API Scan or, if your APIs require authentication, configure API Authentication settings for this collection.

What’s Next?

Ready to scan? Continue to Unauthenticated API Scan.
Your APIs need authentication to access? Learn how to set up Authenticated API Scans.