Report Management

post

/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:

JSON schema:
1
{
2
  "type":"object",
3
  "properties": {
4
    "IsSuccess": {
5
      "type":"boolean",
6
      "required": true
7
    },
8
    "ErrorMessage": {
9
      "type":["string", "null"],
10
      "required": true
11
    },
12
    "Reason": {
13
      "type":["string", "null"],
14
      "required": true
15
    },
16
    "ScanId": {
17
      "type":["string", "null"],
18
      "required": true
19
    }
20
  },
21
  "additionalProperties": false
22
}
post

/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:

JSON schema:
1
{
2
  "type":"object",
3
  "properties": {
4
    "IsSuccess": {
5
      "type":"boolean",
6
      "required": true
7
    },
8
    "ErrorMessage": {
9
      "type":["string", "null"],
10
      "required": true
11
    },
12
    "Reason": {
13
      "type":["string", "null"],
14
      "required": true
15
    },
16
    "ScanId": {
17
      "type":["string", "null"],
18
      "required": true
19
    }
20
  },
21
  "additionalProperties": false
22
}
get

/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

JSON schema:
1
{
2
  "type":"object",
3
  "properties": {
4
    "IsSuccess": {
5
      "type":"boolean",
6
      "required": true
7
    },
8
    "ErrorMessage": {
9
      "type":["string", "null"],
10
      "required": true
11
    },
12
    "Reason": {
13
      "type":["string", "null"],
14
      "required": true
15
    }
16
  },
17
  "additionalProperties": false
18
}
get

/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

JSON schema:
1
{
2
  "type":"object",
3
  "properties": {
4
    "IsSuccess": {
5
      "type":"boolean",
6
      "required": true
7
    },
8
    "ErrorMessage": {
9
      "type":["string", "null"],
10
      "required": true
11
    },
12
    "Reason": {
13
      "type":["string", "null"],
14
      "required": true
15
    }
16
  },
17
  "additionalProperties": false
18
}
get

/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

JSON schema:
1
{
2
  "type":"object",
3
  "properties": {
4
    "IsSuccess": {
5
      "type":"boolean",
6
      "required": true
7
    },
8
    "ErrorMessage": {
9
      "type":["string", "null"],
10
      "required": true
11
    },
12
    "Reason": {
13
      "type":["string", "null"],
14
      "required": true
15
    }
16
  },
17
  "additionalProperties": false
18
}