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)

Name	Type	Required	Description
scanId	guid[]	N	Update scan report if scanId provided and create new scan details if not
reportData	multipart/form-data file	Y	Report file
configId	guid[]	N	Config id uploaded report attached to

Response Messages

Response status code	Reason	Description
200		Report updated, uploaded
400	InvalidJsonSchema	Required parameters not provided
400	ScanNotFound	Scan with ‘scanId’ not found
400	CantHaveReport	Scan status should be Completed, Stopped, Failed or VulnLoadFailed to update report
400	ConfigNotFound	Config 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

Name	Type	Required	Description
scanId	guid[]	Y	Scan ID
file	file	Y	Checkmarx report XML file

Response Messages

Response status code	Reason	Description
200		Report updated
400	InvalidStructure	Invalid 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

Name	Type	Required	Description
scanId	guid[]	Y	Scan ID

Response Messages

Response status code	Reason	Description
200		Response contains link to file
400	InvalidJsonSchema	Required parameters not provided
400	ScanNotFound	Scan with ‘scanId’ not found
400	NoReport	Scan report unavailable. Scan status is not “Completed” or “Stopped”
400	FileNotFound	Report 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

Name	Type	Required	Description
scanId	guid[]	Y	Scan ID

Response Messages

Response status code	Reason	Description
200		Response contains link to file
400	InvalidJsonSchema	Required parameters not provided
400	ScanNotFound	Scan with ‘scanId’ not found
400	NoReport	Scan report unavailable. Scan status is not “Completed” or “Stopped”
400	FileNotFound	Report 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

Name	Type	Required	Description
scanId	guid[]	Y	Scan ID

Response Messages

Response status code	Reason	Description
200		Response contains link to file
400	InvalidJsonSchema	Required parameters not provided
400	ScanNotFound	Scan with ‘scanId’ not found
400	NoReport	Scan report unavailable. Scan status is not “Completed” or “Stopped”
400	FileNotFound	Report 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
}