Skip to main content

​
List pentests

Retrieve pentests with optional filters and pagination. 
curl -X GET "https://app.strix.ai/api/v1/scans?limit=20" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"
Required scope: scans:read

​
Start a new pentest

Provide domain_ids for blackbox pentests or repository_ids for whitebox pentests. 
curl -X POST "https://app.strix.ai/api/v1/scans" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "domain_ids": ["<DOMAIN_ID>"],
    "concerns": "Check for authentication bypass vulnerabilities"
  }'
Required scope: scans:write

​
Get pentest detail

curl -X GET "https://app.strix.ai/api/v1/scans/<SCAN_ID>" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"
Required scope: scans:read

​
Rerun a pentest

Re-execute a previous pentest configuration: 
curl -X POST "https://app.strix.ai/api/v1/scans/<SCAN_ID>/rerun" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"
Required scope: scans:write

​
Cancel a pentest

Cancel a pending or running pentest: 
curl -X POST "https://app.strix.ai/api/v1/scans/<SCAN_ID>/cancel" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"
Required scope: scans:write

​
Download report

Download the PDF report for a completed pentest: 
curl -X GET "https://app.strix.ai/api/v1/scans/<SCAN_ID>/report" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -o report.pdf
Required scope: scans:read