Skip to main content

Schema for the rl-checks report format

The Spectra Assure platform supports a special format for analysis reports called rl-checks. This format provides a summary of all checks performed during software package analysis, and it's particularly suitable for workflows involving reproducible builds.

To generate reports in the rl-checks format:

  • with rl-secure CLI, use the rl-secure report command
  • with the Spectra Assure Portal APIs, use the "Export analysis report" endpoint

This page describes the full schema of the rl-checks report format.

How to read the schema?​

The schema contents are described on the left in alphabetical order. Expandable items in the schema have an arrow indicator next to their name. Click the arrow to expand the item and view its contents.

The full rl-checks report example is displayed on the right. You can copy the whole example by selecting "Copy" or expand/collapse all example fields on the right.

To make the schema easier to read, you can hide the navigation sidebar by selecting the << button at the bottom left of the page.

duration
required
string

Indicates how long it took to complete the analysis.

schema
required
number

Version of the report schema. Version number is incremented to indicate a break of backwards compatibility.

timestamp
required
string <date-time>

Indicates when the software package was last analyzed in ISO-8601 time format.

version
required
string

Version of the analysis engine that was used to scan the software package.

required
object

Summary of checks performed by Spectra Assure during analysis.

{
  • "duration": "00:00:02.334",
  • "schema": 1,
  • "timestamp": "2023-04-06T17:09:44+02:00",
  • "version": "5.0.0.1",
  • "report": {
    }
}