v1
latestOpenAPI 3.0.02026-07-249055687.1 KBfull-scans
Generate PDF report for full scan
Generate a PDF report for all alerts in a full scan.
This endpoint streams a PDF document containing all alerts found in the full scan, with optional filtering and grouping options.
Supported request body filter IDs include:
- alert.action (error|warn|monitor|ignore)
- alert.type
- alert.category
- alert.severity (low|medium|middle|high|critical or 0-3)
- artifact.type (purl type, e.g. npm, pypi)
- dependency.type (direct|transitive)
- dependency.scope (dev|normal)
- dependency.usage (used|unused)
- manifest.file
This endpoint consumes 1 unit of your quota.
This endpoint requires the following org token scopes:
- full-scans:list
post/orgs/{org_slug}/full-scans/{full_scan_id}/format/pdf
Path parameters
org_slugstring required
The slug of the organization
full_scan_idstring required
The ID of the full scan
Query parameters
Control which alert priority fields to include in the response. Set to "true" to include all fields, "false" to exclude all fields, or specify individual fields like "components,formula" to include only those fields.
include_license_detailsboolean required
Include license details in the response.
Request body
Response
PDF report of alerts