Skip to main content

Exporting a Report

To export a scanning report via API:

  1. Go to the Report section.
  2. Select desired option of export: download (/report/file/) or receive by an e-mail (/report/email/).
  3. Press Try it out.
  4. In the request body provide the UUID of the desired project and scan and set up report parameters.
  5. Press Execute.

Get a PDF report:

curl -X 'POST' 'http://YOUR_IP_ADDRESS/app/api/v1/report/file' 
-H 'accept: application/octet-stream'
-H 'Authorization: Bearer YOUR_API_TOKEN'
-H 'Content-Type: multipart/form-data'
-F 'settings={
"projectUuid": "YOUR_PROJECT_UUID",
"scanUuids": ["YOUR_SCANS_UUID"],
"exportSettings": {
"uuid": "string",
"projectInfoSettings": {
"securityLevelDynamics": true,
"vulnNumberDynamics": true,
"scanHistory": 0
},
"sort": "CR",
"scanInfoSettings": {
"included": true,
"foundVulnChart": true,
"typeVulnChart": true,
"langStats": true,
"fileStats": false,
"scanErrorInfo": true,
"scanSettings": true,
"includeVersionProperties": false
},
"filterSettings": {
"critical": true,
"medium": true,
"low": true,
"info": true,
"standardLibs": true,
"classFiles": true,
"waf": true,
"jira": false
},
"confidence": {
"included": false,
"critical": 0,
"medium": 0,
"low": 0,
"info": 0,
"percentile": 0,
"mode": "TRUE"
},
"lang": "ABAP,ANDROID,APEX,CS,CCPP,COBOL,CONFIG,DART,DELPHI,GO,GROOVY,HTML5,JAVA,JAVASCRIPT,KOTLIN,LOTUS,OBJC,PASCAL,PHP,PLSQL,PYTHON,PERL,RUBY,RUST,SCALA,SOLIDITY,SWIFT,TSQL,TSX,TYPESCRIPT,VBNET,VBA,VBSCRIPT,VB,VYPER,ONES",
"tableSettings": {
"included": true,
"entriesSettings": {
"notProcessed": true,
"confirmed": true,
"rejected": false
},
"entryNum": 0
},
"detailedResultsSettings": {
"included": true,
"entriesSettings": {
"notProcessed": true,
"confirmed": true,
"rejected": false
},
"entryNum": 0,
"comment": true,
"event": true,
"jiraInfo": false,
"traceNum": 1,
"sourceCodeNum": 3
},
"wafSettings": {
"included": true,
"entriesSettings": {
"notProcessed": true,
"confirmed": true,
"rejected": false
},
"imperva": true,
"mod": true,
"f5": true
},
"generalSettings": {
"reportSettings": true,
"contents": true,
"showStatus": true,
"showDastCorrelation": true,
"locale": "en",
"format": "PDF"
}
},
"comparisonSettings": {
"included": false,
"scanUuid": "string",
"newIssue": true,
"saved": true,
"fixed": true,
"entryNum": 0,
"scanSettings": true
}
};type=application/json' > YOUR_OUTPUT_HERE