PDF Reports
NAT can export any scan result as a polished, self-contained PDF document. PDF reports are ideal for sharing with stakeholders who don't have a NAT account, submitting to compliance auditors, or archiving a point-in-time snapshot of your API security posture.
PDF export is available on Pro and above. Enterprise plans include a white-label option that removes NAT branding. See feature availability.
What the PDF contains
A NAT PDF report is a faithful export of the unified HTML report in a paginated, print-ready format. It includes:
- Cover page β workspace name, scan target, date, plan tier
- Executive summary β finding counts by severity, pass/fail rates, scan duration
- Findings table β all findings with severity, OWASP category, endpoint, and evidence
- Root Cause Analysis section β AI-generated root causes and fix suggestions (when RCA data is available)
- Remediation guidance β per-finding code-level fix recommendations
- Appendix β raw request/response evidence for each finding
CLI
Export a scan result as PDF from the command line:
nat scan --scan-id scan_01HXY3Z7KQNVJG84WDPT6BCS9 --output pdfOr run a new scan and export the results immediately:
nat scan --spec openapi.yaml --base-url https://api.example.com --output pdfThe PDF is saved to ./nat-report-<scan_id>.pdf by default. Specify a custom output path with --output-path:
nat scan --scan-id scan_01HXY3Z7KQNVJG84WDPT6BCS9 --output pdf --output-path ./reports/q1-audit.pdfAvailable flags
| Flag | Description | Default |
|---|---|---|
--output pdf | Export results as PDF | β |
--output-path <path> | PDF file path | ./nat-report-<scan_id>.pdf |
--scan-id <id> | Export an existing scan by ID | β |
API
Export a scan as PDF
GET /api/v1/scan/{scan_id}/export?format=pdf
X-API-Key: $NAT_API_KEYThe response is a binary PDF file with Content-Type: application/pdf and a Content-Disposition: attachment header.
curl "https://api.nat-testing.io/api/v1/scan/scan_01HXY3Z7KQNVJG84WDPT6BCS9/export?format=pdf" \
-H "X-API-Key: $NAT_API_KEY" \
--output report.pdfThe endpoint also supports format=html and format=json for other export formats.
Dashboard
On any scan detail page, click the π Download PDF button in the top-right action bar. The PDF is generated on demand and downloaded immediately.
Open a scan result
Navigate to Testing β Scans and click any completed scan to open the detail view.
Download PDF
Click π Download PDF in the action bar at the top of the page.
Save or share
Your browser's standard download prompt opens. Save the file locally, or use your OS share sheet to send it directly.
Enterprise white-label option
Enterprise workspaces can remove NAT branding from PDF reports and replace it with their own organization logo and name.
Configure white-label settings in Settings β Team β PDF Branding:
| Setting | Description |
|---|---|
| Organization name | Replaces "NAT" on the cover page |
| Logo | Upload a PNG or SVG (max 2 MB); displayed on the cover page and header |
| Primary color | Hex color used for headings and severity badges |
| Footer text | Custom footer text on every page (e.g., "Confidential β Acme Corp Internal Use Only") |
White-label branding applies to all PDF exports from the workspace, including those generated via the API and CLI.
Feature availability
| Plan | PDF export | White-label |
|---|---|---|
| Free | β Not available | β |
| Pro | β | β |
| Team | β | β |
| Enterprise | β | β |
Attempting to call GET /api/v1/scan/{scan_id}/export?format=pdf on a Free plan returns 403 Forbidden with error code FEATURE_NOT_AVAILABLE.
Related
- Root Cause Analysis β AI-generated fix suggestions included in PDF reports
- Dashboard 2.0 β full guide to the updated dashboard
- Pricing & Plans β plan comparison and quotas
- CLI Reference β all
natcommands and flags