Documentation Reports and formats

Every scan ends in a report: a verdict and the fixes in order of importance. You can read it in the browser, in your terminal or in your own tools.

Verdicts

Every report opens with one of three verdicts.

VerdictIn the APIWhat it means
ReadyreadyNothing needs fixing before you merge.
Almost readyalmost_readyA short list of fixes comes first. The rest can wait.
Not readynot_readyThere is at least one critical finding. Fix it before you merge.

Levels

Every finding has a level. The --fail-on option of the command line uses the same four.

LevelWhat it means
criticalCan be used against you today and the damage is serious. Fix it now.
highSerious, but harder to use or more limited. Fix it before the next release.
mediumWorth fixing, with no hurry.
lowGood to know. It is counted and parked.

The simple report

Free scans come with the simple report.

  • The verdict: ready, almost ready or not ready
  • How many findings there are, by severity
  • The top fixes, each with its file and line
  • Which dependencies have known vulnerabilities

The full report

Paid plans and Charter packs give you the full report.

  • Every finding with its step-by-step trace
  • A proposed fix for each one
  • Whether each finding can be reached from an entry point
  • Dependencies, secrets, infrastructure as code and licences
  • Findings grouped by root cause
  • Exports: SARIF for GitHub, GitLab and Azure DevOps, HTML and PDF

Formats

FormatWhat you get
pdfThe report as a document to send or file.
htmlThe report as a single page that opens in any browser.
jsonEvery finding as data, for your own tools.
sarifFindings for GitHub, GitLab and Azure DevOps code scanning.

The formats you can download depend on your plan.

Three ways to get a report

WhereHow
BrowserOpen the report in your account and use the download button.
Command linesc report last shows it and sc download last --format pdf saves it.
APIGET /reports/{id}/download?format=pdf returns the file.
sc reports
sc report last
sc download last --format pdf

Report IDs

Every report has an ID that starts with r_, such as r_8f3k2a. The command line and the API use it to find the report. In the command line, the word last stands for your latest report.

Delete a report

The repository you send is deleted when the analysis ends. The report stays in your account until you delete it.

sc delete r_8f3k2a

A deleted report cannot be recovered.

Scan yours before the next merge.