Get Scan

Get a scan of one of your sites using the embedded Burp Scanner. A Scan object is created based on the associated schedule item when the scan is due to start.

External Documentation

To learn more, visit the PortSwigger documentation.

Parameters

Parameter	Description
Scan ID	The ID of the scan to get information for. Can be retrieved from the 'List Scans' action.

Example Output

{
    "data": {
        "scan": {
            "id": "4",
            "status": "succeeded",
            "agent": {
                "id": null,
                "name": null
            },
            "site_application_logins": {
                "login_credentials": [],
                "recorded_logins": []
            },
            "audit_items": [
                {
                    "id": "500117",
                    "issue_counts": {
                        "total": 1
                    },
                    "number_of_requests": 325
                }
            ],
            "scan_configurations": [
                {
                    "id": null,
                    "name": null
                }
            ],
            "settings": {
                "request_headers": [],
                "request_cookies": []
            }
        }
    }
}

Workflow Library Example

Get Scan with Portswigger and Send Results Via Email

Preview this Workflow on desktop