Creating an API scan using an OpenAPI specification file

You can use an OpenAPI specification file to automatically scan your API. It ensures a more thorough and accurate scan, helping to find potential issues across the entire API.

Before you begin

Procedure

  1. On the Application page, click Create scan, then click Create scan under DAST Dynamic Analysis.
  2. In the Create scan: DAST dialog, choose API scan to begin the configuration process.
  3. Select the API explore method, OpenAPI.
  4. You can add the specification file as a URL or upload the file.
    1. Select URL and then enter the URL in the OpenAPI URL field.
    2. Select File, click Select OpenAPI specification file to choose the file from your local drive, then click Open.
      Note: AppScan accepts only JSON or YAML formats for the specification file.
  5. In the Base URL field, enter a verified or allowed domain.
  6. Configure the other scan options as required such as authentication, test policies and other advanced settings. For more information, see Creating an API scan.
  7. Click Scan to run the scan and detect any vulnerabilities in your web API.

What to do next

  • You can view the status of the scan on the Scans and sessions page.