API Reference

Generate PDF report for full scan

post
https://api.socket.dev/v0/orgs//full-scans//format/pdf

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
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The slug of the organization

string
required

The ID of the full scan

Query Params
Defaults to false

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.

boolean
required
Defaults to false

Include license details in the response.

Body Params
filters
array of objects
filters
string
string
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 3 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago