Skip to main content

report

Description

The report job allows you to generate reports using any of the installed report templates.

Notice

This jobs is only supported in the pipeline approach (using the docker image to run the DAST scan) and for the traditional-pdf format.

Job Structure example

- parameters:
    template: "traditional-pdf"
    reportDir: ""
    reportTitle: "ZAP Scanning Report"
    reportDescription: ""
  name: "report-pdf"
  type: "report"

Possible parameters

Glossary
confidences: <list> (Default - all)

The confidences to include in this report. High, Medium, Low, or falsepositive.

displayReport: <boolean> (Default - false)

Display the report when generated.

reportDescription: <string>

The report description.

reportDir: <string>

The directory into which the report will be written.

reportFile: <string> (Default - {{yyyy-MM-dd}}-ZAP-Report-[[site]])

The report file pattern.

reportTitle: <string>

The report title.

risks: <list> (Default - all)

The risks to include in this report. High, Medium, Low, or Info.

sections: <list> (Default - all)

The template sections to include in this report - see the relevant template.

template: <string> (Default - traditional-html)

The template ID.

Name

Description

Type / Default

template:

The template id

String, default: traditional-html

reportDir:

The directory into which the report will be written

String

reportFile:

The report file name pattern

String, default: {{yyyy-MM-dd}}-ZAP-Report-[[site]]

reportTitle:

The report title

String

reportDescription:

The report description

String

displayReport:

Display the report when generated

Boolean, default: false

risks:

The risks to include in this report

List, default: all

  • high

  • medium

  • low

  • info

confidences:

The confidences to include in this report

List, default: all

  • high

  • medium

  • low

  • falsepositive

sections:

The template sections to include in this report - see the relevant template

List, default all