Skip to main content
GET
/
scans
Get all scans
curl --request GET \
  --url https://app.pentest-tools.com/api/v2/scans \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "tool_id": 123,
      "id": 123,
      "target_id": 123,
      "status_name": "running",
      "vpn_scan": true,
      "progress": 50,
      "result_summary": {
        "text": "<string>",
        "critical": 123,
        "high": 123,
        "medium": 123,
        "low": 123,
        "info": 123
      },
      "start_time": "2023-11-07T05:31:56Z",
      "end_time": "2023-11-07T05:31:56Z",
      "duration": 123,
      "num_tests": 123,
      "num_finished_tests": 123,
      "status_message": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Use the "API key" from the profile page as the token

Query Parameters

​
tool_id
integer

ID of the tool to show scans from

​
workspace_id
integer

ID of the workspace to show scans from. If not set, the scans from the active workspace (set in the web interface) will be returned.

​
target_id
integer

ID of the target to show scans from

​
status
enum<string>

Status of the scans to be shown

Available options:
running,
finished,
failed to start,
stopped,
timed out,
waiting,
aborted,
VPN connection error,
auth failed,
connection error
​
limit
integer
default:1000

the maximum number of scans to return

Required range: 1 <= x <= 1000
​
page
integer
default:1

the page number to return

Required range: x >= 1
​
start_time
object

Start time interval of the scans to be shown

Response

OK

​
data
(Subdomain Finder · object | Whois Lookup · object | Port Scanner · object | URL Fuzzer · object | Virtual Hosts Finder · object | Website Scanner · object | ICMP Ping · object | SharePoint Scanner · object | Wordpress Scanner · object | Drupal Scanner · object | Joomla Scanner · object | Website Recon · object | Network Scanner · object | SQLi Exploiter · object | Domain Finder · object | Password Auditor · object | SSL Scanner · object | Sniper · object | WAF Detector · object | API Scanner · object | Cloud Scanner · object | People Hunter · object | KubernetesScanner · object)[]
required
Maximum array length: 1000