Report Management

/AppSpiderEnterprise/rest/v1/Report/ImportStandardReport Description Creates a new scan in the scan history or updates the report for the specified scan

Parameters

ℹ️

Note

Multipart/form-data request must be used to upload file(s)

NameTypeRequiredDescription
scanIdguid[]NUpdate scan report if scanId provided and create new scan details if not
reportDatamultipart/form-data fileYReport file
configIdguid[]NConfig id uploaded report attached to

Response Messages

Response status codeReasonDescription
200Report updated, uploaded
400InvalidJsonSchemaRequired parameters not provided
400ScanNotFoundScan with ‘scanId’ not found
400CantHaveReportScan status should be Completed, Stopped, Failed or VulnLoadFailed to update report
400ConfigNotFoundConfig with ‘configId’ not found

Response example:

{ "type":"object", "properties": { "IsSuccess": { "type":"boolean", "required": true }, "ErrorMessage": { "type":["string", "null"], "required": true }, "Reason": { "type":["string", "null"], "required": true }, "ScanId": { "type":["string", "null"], "required": true } }, "additionalProperties": false }

/AppSpiderEnterprise/rest/v1/Report/ImportCheckmarxReport Description Uploads checkmarx report

Parameters

NameTypeRequiredDescription
scanIdguid[]YScan ID
filefileYCheckmarx report XML file

Response Messages

Response status codeReasonDescription
200Report updated
400InvalidStructureInvalid checkmarx report structure

Response example:

{ "type":"object", "properties": { "IsSuccess": { "type":"boolean", "required": true }, "ErrorMessage": { "type":["string", "null"], "required": true }, "Reason": { "type":["string", "null"], "required": true }, "ScanId": { "type":["string", "null"], "required": true } }, "additionalProperties": false }

/AppSpiderEnterprise/rest/v1/Report/GetReportZip Description Gets ReportAllFiles.zip for the scan. Only scans in “Completed” and “Stopped” states may have reports

Parameters

NameTypeRequiredDescription
scanIdguid[]YScan ID

Response Messages

Response status codeReasonDescription
200Response contains link to file
400InvalidJsonSchemaRequired parameters not provided
400ScanNotFoundScan with ‘scanId’ not found
400NoReportScan report unavailable. Scan status is not “Completed” or “Stopped”
400FileNotFoundReport file doesn’t exist

Response example: File results for a successful request. If error occurred

{ "type":"object", "properties": { "IsSuccess": { "type":"boolean", "required": true }, "ErrorMessage": { "type":["string", "null"], "required": true }, "Reason": { "type":["string", "null"], "required": true } }, "additionalProperties": false }

/AppSpiderEnterprise/rest/v1/Report/GetVulnerabilitiesSummaryXml Description Gets VulnerabilitiesSummary.xml for the scan. Only scans in “Completed” and “Stopped” states may have a report

Parameters

NameTypeRequiredDescription
scanIdguid[]YScan ID

Response Messages

Response status codeReasonDescription
200Response contains link to file
400InvalidJsonSchemaRequired parameters not provided
400ScanNotFoundScan with ‘scanId’ not found
400NoReportScan report unavailable. Scan status is not “Completed” or “Stopped”
400FileNotFoundReport file does not exist

Response example: File results for a successful request. If error occurred

{ "type":"object", "properties": { "IsSuccess": { "type":"boolean", "required": true }, "ErrorMessage": { "type":["string", "null"], "required": true }, "Reason": { "type":["string", "null"], "required": true } }, "additionalProperties": false }

/AppSpiderEnterprise/rest/v1/Report/GetCrawledLinksXml Description Gets CrawledLinks.xml for the scan. Only scans in “Completed” and “Stopped” states may have a report

Parameters

NameTypeRequiredDescription
scanIdguid[]YScan ID

Response Messages

Response status codeReasonDescription
200Response contains link to file
400InvalidJsonSchemaRequired parameters not provided
400ScanNotFoundScan with ‘scanId’ not found
400NoReportScan report unavailable. Scan status is not “Completed” or “Stopped”
400FileNotFoundReport file does not exist

Response example: File results for a successful request. If error occurred

{ "type":"object", "properties": { "IsSuccess": { "type":"boolean", "required": true }, "ErrorMessage": { "type":["string", "null"], "required": true }, "Reason": { "type":["string", "null"], "required": true } }, "additionalProperties": false }