PDF Reports

What's in a PDF report

PDF reports are generated with ReportLab and are designed to be shared with clients, management, or compliance teams without modification.

Each report includes:

• Cover page — target URL, scan date, scan type, severity summary
• Executive summary — finding counts by severity, overall risk rating
• Detailed findings — one section per finding with title, severity, description, evidence, and remediation
• OWASP mapping — each finding mapped to its OWASP Top 10 category
• Compliance references — PCI-DSS v4, GDPR, ISO 27001, SOC 2 mappings
• CVSS scores — where available
• CWE references — Common Weakness Enumeration IDs
• Performance section — included in Full and Performance scans

Downloading a report

From the dashboard, after a scan completes:

1. Click on the completed scan in the results panel or History tab
2. Click Download PDF
3. The report downloads immediately as shieldome-report-{id}.pdf

Via API:

curl -H "X-Shieldome-Key: YOUR_API_KEY" \
     https://yourdomain.com/api/scan/{scan_id}/report \
     -o report.pdf

Bulk PDF reports

You can generate a single PDF that combines multiple scans — useful for batch jobs or periodic summary reports.

curl -X POST \
     -H "X-Shieldome-Key: YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"scan_ids": ["id1", "id2", "id3"]}' \
     https://yourdomain.com/api/report/bulk \
     -o bulk-report.pdf

Word (.docx) reports

DOCX format is available as an alternative if you need to edit the report:

curl -H "X-Shieldome-Key: YOUR_API_KEY" \
     https://yourdomain.com/api/scan/{scan_id}/docx \
     -o report.docx

White-label reports

All token pack holders can replace Shieldome branding in PDF and DOCX reports with their own identity. This is useful for agencies and MSSPs who deliver reports under their own brand.

Configure white-label settings in Settings → White Label: