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
- Backup your site before scanning.
- If you have not yet done so, Create an application for your scans.
- Verify with ASoC that you have permission to scan the domain (see Verifying a domain), or you can authorize domains without verification using Domain management.
- If your site is not available on the Internet, and an AppScan Presence does not yet exist on the server: Creating the AppScan Presence.
- If scanning a live production site, refer first to What changes should I make when scanning a live production site?
Procedure
- On the Application page, click Create scan, then click Create scan under DAST Dynamic Analysis.
- In the Create scan: DAST dialog, choose API scan to begin the configuration process.
- Select the API explore method, OpenAPI.
-
You can add the specification file as a URL or upload the file.
- In the Base URL field, enter a verified or allowed domain.
- Configure the other scan options as required such as authentication, test policies and other advanced settings. For more information, see Creating an API scan.
- 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.