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.
| Verdict | In the API | What it means |
|---|---|---|
| Ready | ready | Nothing needs fixing before you merge. |
| Almost ready | almost_ready | A short list of fixes comes first. The rest can wait. |
| Not ready | not_ready | There 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.
| Level | What it means |
|---|---|
critical | Can be used against you today and the damage is serious. Fix it now. |
high | Serious, but harder to use or more limited. Fix it before the next release. |
medium | Worth fixing, with no hurry. |
low | Good 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
| Format | What you get |
|---|---|
pdf | The report as a document to send or file. |
html | The report as a single page that opens in any browser. |
json | Every finding as data, for your own tools. |
sarif | Findings for GitHub, GitLab and Azure DevOps code scanning. |
The formats you can download depend on your plan.
Three ways to get a report
| Where | How |
|---|---|
| Browser | Open the report in your account and use the download button. |
| Command line | sc report last shows it and sc download last --format pdf saves it. |
| API | GET /reports/{id}/download?format=pdf returns the file. |
sc reports
sc report last
sc download last --format pdfReport 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_8f3k2aA deleted report cannot be recovered.