Scan Management

get

/AppSpiderEnterprise/rest/v1/Scan/GetScans

Description Retrieves the scans list for the client

Parameters No parameters

Response Messages

Response status code

Reason

Description

200

Response contains the list of scans

Response example:

JSON schema:
1
{
2
  "type":"object",
3
  "properties": {
4
    "Scans": {
5
      "type":"array",
6
      "items": {
7
        "type":"object",
8
        "properties": {
9
          "Id": {
10
            "type":"string",
11
            "required": true
12
          },
13
          "EngineGroupId": {
14
            "type":["string", "null"],
15
            "required": true
16
          },
17
          "EngineId": {
18
            "type":["string", "null"],
19
            "required": true
20
          },
21
          "Token": {
22
            "type":["string", "null"],
23
            "required": true
24
          },
25
          "Status": {
26
            "type":"integer",
27
            "required": true
28
          },
29
          "StartTime": {
30
            "type":["string", "null"],
31
            "required": true
32
          },
33
          "WindowsScanStart": {
34
            "type":["string", "null"],
35
            "required": true
36
          },
37
          "WindowScanStop": {
38
            "type":["string", "null"],
39
            "required": true
40
          },
41
          "StopTime": {
42
            "type":["string", "null"],
43
            "required": true
44
          },
45
          "CompletionTime": {
46
            "type":["string", "null"],
47
            "required": true
48
          },
49
          "StartedBy": {
50
            "type":["string", "null"],
51
            "required": true
52
          },
53
          "ConfigId": {
54
            "type":["string", "null"],
55
            "required": true
56
          },
57
          "IsApproveRequired": {
58
            "type":"boolean",
59
            "required": true
60
          },
61
          "IsMonitoring": {
62
            "type":"boolean",
63
            "required": true
64
          },
65
          "IsUploaded": {
66
            "type":"boolean",
67
            "required": true
68
          },
69
          "IsImported": {
70
            "type":"boolean",
71
            "required": true
72
          },
73
          "Targets": {
74
            "type":"array",
75
            "items": {
76
              "type":"object",
77
              "properties": {
78
                "Id": {
79
                  "type":"string",
80
                  "required": true
81
                },
82
                "Host": {
83
                  "type":"string",
84
                  "required": true
85
                },
86
              }
87
            }
88
          }
89
        },
90
        "additionalProperties": false
91
      }
92
    },
93
    "IsSuccess": {
94
      "type":"boolean"
95
      "required": true
96
    },
97
    "ErrorMessage": {
98
      "type":["string", "null"],
99
      "required": true
100
    },
101
    "Reason": {
102
      "type":["string", "null"],
103
      "required": true
104
    }
105
  },
106
  "additionalProperties": false
107
}

/AppSpiderEnterprise/rest/v1/Scan/GetScans

Description Retrieves the list of scans for the client by the config id

Parameters

Parameters

Type

Required

Description

configId

guid[]

Y

The config id

Response Messages

Response status code

Reason

Description

200

Response contains the list of scans

400

Config Id does not exist in client

Response example:

json
1
{
2
  "type":"object",
3
  "properties": {
4
    "Scans": {
5
      "type":"array",
6
      "items": {
7
        "type":"object",
8
        "properties": {
9
          "Id": {
10
            "type":"string",
11
            "required": true
12
          },
13
          "EngineGroupId": {
14
            "type":["string", "null"],
15
            "required": true
16
          },
17
          "EngineId": {
18
            "type":["string", "null"],
19
            "required": true
20
          },
21
          "Token": {
22
            "type":["string", "null"],
23
            "required": true
24
          },
25
          "Status": {
26
            "type":"integer",
27
            "required": true
28
          },
29
          "StartTime": {
30
            "type":["string", "null"],
31
            "required": true
32
          },
33
          "WindowsScanStart": {
34
            "type":["string", "null"],
35
            "required": true
36
          },
37
          "WindowScanStop": {
38
            "type":["string", "null"],
39
            "required": true
40
          },
41
          "StopTime": {
42
            "type":["string", "null"],
43
            "required": true
44
          },
45
          "CompletionTime": {
46
            "type":["string", "null"],
47
            "required": true
48
          },
49
          "StartedBy": {
50
            "type":["string", "null"],
51
            "required": true
52
          },
53
          "ConfigId": {
54
            "type":["string", "null"],
55
            "required": true
56
          },
57
          "IsApproveRequired": {
58
            "type":"boolean",
59
            "required": true
60
          },
61
          "IsMonitoring": {
62
            "type":"boolean",
63
            "required": true
64
          },
65
          "IsUploaded": {
66
            "type":"boolean",
67
            "required": true
68
          },
69
          "IsImported": {
70
            "type":"boolean",
71
            "required": true
72
          },
73
          "Targets": {
74
            "type":"array",
75
            "items": {
76
              "type":"object",
77
              "properties": {
78
                "Id": {
79
                  "type":"string",
80
                  "required": true
81
                },
82
                "Host": {
83
                  "type":"string",
84
                  "required": true
85
                },
86
              }
87
            }
88
          }
89
        },
90
        "additionalProperties": false
91
      }
92
    },
93
    "IsSuccess": {
94
      "type":"boolean"
95
      "required": true
96
    },
97
    "ErrorMessage": {
98
      "type":["string", "null"],
99
      "required": true
100
    },
101
    "Reason": {
102
      "type":["string", "null"],
103
      "required": true
104
    }
105
  },
106
  "additionalProperties": false
107
}

/AppSpiderEnterprise/rest/v1/Scan/GetScans

Description Retrieves the list of scans for the client by the config id with paging

Parameters

Parameters

Type

Required

Description

configId

guid[]

Y

The config id

page

int

Y

The page of results to return (page starts at 0)

pageSize

int

Y

The number of results to return per page

Response Messages

Response status code

Reason

Description

200

Response contains the list of scans

400

Config Id does not exist in client

Response example:

json
1
{
2
  "type":"object",
3
  "properties": {
4
    "Scans": {
5
      "type":"array",
6
      "items": {
7
        "type":"object",
8
        "properties": {
9
          "Id": {
10
            "type":"string",
11
            "required": true
12
          },
13
          "EngineGroupId": {
14
            "type":["string", "null"],
15
            "required": true
16
          },
17
          "EngineId": {
18
            "type":["string", "null"],
19
            "required": true
20
          },
21
          "Token": {
22
            "type":["string", "null"],
23
            "required": true
24
          },
25
          "Status": {
26
            "type":"integer",
27
            "required": true
28
          },
29
          "StartTime": {
30
            "type":["string", "null"],
31
            "required": true
32
          },
33
          "WindowsScanStart": {
34
            "type":["string", "null"],
35
            "required": true
36
          },
37
          "WindowScanStop": {
38
            "type":["string", "null"],
39
            "required": true
40
          },
41
          "StopTime": {
42
            "type":["string", "null"],
43
            "required": true
44
          },
45
          "CompletionTime": {
46
            "type":["string", "null"],
47
            "required": true
48
          },
49
          "StartedBy": {
50
            "type":["string", "null"],
51
            "required": true
52
          },
53
          "ConfigId": {
54
            "type":["string", "null"],
55
            "required": true
56
          },
57
          "IsApproveRequired": {
58
            "type":"boolean",
59
            "required": true
60
          },
61
          "IsMonitoring": {
62
            "type":"boolean",
63
            "required": true
64
          },
65
          "IsUploaded": {
66
            "type":"boolean",
67
            "required": true
68
          },
69
          "IsImported": {
70
            "type":"boolean",
71
            "required": true
72
          },
73
          "Targets": {
74
            "type":"array",
75
            "items": {
76
              "type":"object",
77
              "properties": {
78
                "Id": {
79
                  "type":"string",
80
                  "required": true
81
                },
82
                "Host": {
83
                  "type":"string",
84
                  "required": true
85
                },
86
              }
87
            }
88
          }
89
        },
90
        "additionalProperties": false
91
      }
92
    },
93
    "IsSuccess": {
94
      "type":"boolean"
95
      "required": true
96
    },
97
    "ErrorMessage": {
98
      "type":["string", "null"],
99
      "required": true
100
    },
101
    "Reason": {
102
      "type":["string", "null"],
103
      "required": true
104
    },
105
    "TotalCount": {
106
        "type": "integer",
107
        "required": true
108
    }, 
109
    "TotalPages": {
110
        "type": "integer",
111
        "required": true
112
    }, 
113
    "Links": {
114
        "type": "array",
115
          "items": {
116
            "Rel": {
117
      				"type":["string", "null"],
118
     					 "required": true
119
            },
120
            "Href": {
121
      				"type":["string", "null"],
122
     					 "required": true
123
            }
124
          }
125
       }
126
    },
127
  },
128
  "additionalProperties": false
129
}
post

/AppSpiderEnterprise/rest/v1/Scan/RunScan

Description Start a scan

Attention

At least one parameter should be provided to start a scan

Parameters

Name

Type

Required

Description

configId

guid[]

N

Scan config ID

configName

string

N

Scan config name

RunScan config

All though neither the 'configId' nor the 'configName' is required at least one of them must be configured for the request to be successful.

Response Messages

Response status code

Reason

Description

200

Scan config removed

400

InvalidJsonSchema

Required parameters not provided

400

ScanStartFailed

Scan config with 'configId' doesn't exist in client. Scan config with 'configName' not found in client. Scan config targets are not approved for user.

post

/AppSpiderEnterprise/rest/v1/Scan/CancelScan

Description Cancels "Starting" or "Waiting for Cloud" scan

Parameters

Name

Type

Required

Description

scanId

guid[]

Y

Scan ID

Response Messages

Response status code

Reason

Description

200

Scan was canceled

400

InvalidJsonSchema

Required parameters not provided

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
  },
17
  "additionalProperties": false
18
}
post

/AppSpiderEnterprise/rest/v1/Scan/PauseScan

Description Pauses a running scan

Parameters

Name

Type

Required

Description

scanId

guid[]

Y

Scan ID

Response Messages

Response status code

Reason

Description

200

Scan was paused

400

InvalidJsonSchema

Required parameters not provided

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
  },
17
  "additionalProperties": false
18
}
post

/AppSpiderEnterprise/rest/v1/Scan/ResumeScan

Description Resumes a paused scan

Parameters

Name

Type

Required

Description

scanId

guid[]

Y

Scan ID

Response Messages

Response status code

Reason

Description

200

Scan was resumed

400

InvalidJsonSchema

Required parameters not provided

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
  },
17
  "additionalProperties": false
18
}
post

/AppSpiderEnterprise/rest/v1/Scan/StopScan

Description Stop a running scan

Parameters

Name

Type

Required

Description

scanId

guid[]

Y

Scan ID

Response Messages

Response status code

Reason

Description

200

Scan was stopped

400

InvalidJsonSchema

Required parameters not provided

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
  },
17
  "additionalProperties": false
18
}
post

/AppSpiderEnterprise/rest/v1/Scan/PauseAllScans

Description Pauses all running scans for the client

Parameters No parameters

Response Messages

Response status code

Reason

Description

200

Scans were paused

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
  },
17
  "additionalProperties": false
18
}
post

/AppSpiderEnterprise/rest/v1/Scan/ResumeAllScans

Description Resumes all paused scans for the client

Parameters No parameters

Response Messages

Response status code

Reason

Description

200

Scans were resumed

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
  },
17
  "additionalProperties": false
18
}
post

/AppSpiderEnterprise/rest/v1/Scan/StopAllScans

Description Stops all scans for the client

Parameters No parameters

Response Messages

Response status code

Reason

Description

200

Scans were stopped

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
  },
17
  "additionalProperties": false
18
}
post

/AppSpiderEnterprise/rest/v1/Scan/CancelAllScans

Description Cancels all "Starting" and "Waiting for cloud" scans for the client

Parameters No parameters

Response Messages

Response status code

Reason

Description

200

Scans were all canceled

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
  },
17
  "additionalProperties": false
18
}
get

/AppSpiderEnterprise/rest/v1/Scan/GetScanStatus

Description Retrieves the scan status represented by a string

Parameters

Name

Type

Required

Description

scanId

guid[]

Y

Scan ID

Response Messages

Response status code

Reason

Description

200

Response contains scan status

400

InvalidJsonSchema

Required parameters not provided

400

ScanNotFound

Scan not found

Response example:

Returned Statuses (case-sensitive): ● "Starting" - scan is starting ● "Starting.." - internal status using for starting scan ● "Running" - scan is running ● "Running.." - internal status using for running scan ● "Running...." - internal status using for running scan ● "Waiting for Cloud" - scan is waiting for cloud scan engine ● "Stopping" - scan is stopping ● "Stopping.." - internal status using for stopping scan ● "Stopping...." - internal status using for stopping scan ● "Waiting for Stopped" - internal status using for stopping scan ● "Waiting for Stopped.." - internal status using for stopping scan ● "Waiting for Stopped...." - internal status using for stopping scan ● "Pausing" - scan is pausing ● "Pausing.." - internal status using for pausing scan ● "Pausing...." - internal status using for pausing scan ● "Resuming" - scan is resuming after pause ● "Resuming.." - internal status using for resuming scan ● "Resuming...." - internal status using for resuming scan ● "Canceling" - scan is canceling ● "Canceling.." - internal status using for canceling scan ● "Canceling...." - internal status using for canceling scan ● "Stopped" - scan is stopped ● "Paused" - scan is paused ● "Pending Blackout" - internal status using for blackouted scan ● "Blackouted" - scan is paused by blackout ● "Pending Upload" - internal status using for uploading scan ● "Hanged" - scan is hanged ● "Failed" - scan is failed ● "Vuln Load Failed" - vulnerabilities load from scan report failed ● "Completed" - scan is completed ● "Starting Upload - internal status using for uploading scan ● "Starting Upload.." - internal status using for uploading scan ● "Starting Update" - internal status using for updating scan ● "Deleting All" - scan deleting is in progress ● "Download failed" - scan report download is failed

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

/AppSpiderEnterprise/rest/v1/Scan/IsScanActive

Description Checks to see if the specified scan is active

Parameters

Name

Type

Required

Description

scanId

guid[]

Y

ScanID

Response Messages

Response status code

Reason

Description

200

Response contains boolean value

400

InvalidJsonSchema

Required parameters not provided

400

ScanNotFound

Scan not found

Response example:

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

/AppSpiderEnterprise/rest/v1/Scan/IsScanFinished

Description Checks to see if the specified scan was completed

Parameters

Name

Type

Required

Description

scanId

guid[]

Y

Scan ID

Response Messages

Response status code

Reason

Description

200

Response contains boolean value

400

InvalidJsonSchema

Required parameters not provided

400

ScanNotFound

Scan not found

Response example:

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

/AppSpiderEnterprise/rest/v1/Scan/HasReport

Description Checks to see if the specified scan has a report

Parameters

Name

Type

Required

Description

scanId

guid[]

Y

Scan ID

Response Messages

Response status code

Reason

Description

200

Response contains boolean value

400

InvalidJsonSchema

Required parameters not provided

400

ScanNotFound

Scan not found

Response example:

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

/AppSpiderEnterprise/rest/v1/Scan/GetScanErrors

Description Gets scan error log

Parameters

Name

Type

Required

Description

scanId

guid[]

Y

Scan ID

Response Messages

Response status code

Reason

Description

200

Response contains boolean value

400

InvalidJsonSchema

Required parameters not provided

400

ScanNotFound

Scan not found

400

ScanIsNotAllowed

User does not have permissions to access scan

Response example:

JSON schema:
1
{
2
  "type":"object",
3
  "properties": {
4
    "Events": {
5
      "type":"array",
6
      "properties": {
7
        "Type": {
8
          "type":"string",
9
          "required": true
10
        },
11
        "Date": {
12
          "type":["string", "null"],
13
          "required": true
14
        },
15
        "Message": {
16
          "type":["string", "null"],
17
          "required": true
18
        }
19
      },
20
      "additionalProperties": false
21
    }
22
  },
23
  "IsSuccess": {
24
    "type":"boolean",
25
    "required": true
26
  },
27
  "ErrorMessage": {
28
    "type":["string", "null"],
29
    "required": true
30
  },
31
  "Reason": {
32
    "type":["string", "null"],
33
    "required": true
34
  }
35
},
36
"additionalProperties": flase
37
}

/AppSpiderEnterprise/rest/v1/Scan/GetScanStatuses

Description Retrieves the list of possible statuses for a scan

Parameters No Parameters

Response Messages

Response status code

Reason

Description

200

Response contains the list of scan status types

Response example:

Returned list of Statuses for a scan (case-sensitive) ● "Starting" - scan is starting ● "PendingStarting" - internal status used for starting scan ● "ValidatingStarting" - internal status used for starting scan ● "Running" - scan is running ● "ValidateRunning" - internal status used for running scan ● "ValidatingRunning" - internal status used for running scan ● "StartingCloud" - scan is waiting for cloud scan engine ● "Stopping" - scan is stopping ● "PendingStopping" - internal status used for stopping scan ● "ValidatingStopping" - internal status using for stopping scan ● "ActStopped" - internal status using for stopping scan ● "ValidateStopped" - internal status using for stopping scan ● "ValidatingStopped" - internal status using for stopping scan ● "Pausing" - scan is pausing ● "PendingPausing" - internal status used for pausing scan ● "ValidatingPausing" - internal status used for pausing scan ● "Resuming" - scan is resuming after pause ● "PendingResuming" - internal status used for resuming scan ● "ValidatingResuming" - internal status used for resuming scan ● "Canceling" - scan is canceling ● "PendingCanceling" - internal status used for canceling scan ● "ValidatingCanceling" - internal status used for canceling scan ● "Stopped" - scan is stopped ● "Paused" - scan is paused ● "PendingPauseByBlackout" - internal status used for blackouted scan ● "PausedByBlackout" - scan is paused by blackout ● "PendingUpload" - internal status used for uploading scan ● "Hanged" - scan is hanged ● "Failed" - scan is failed ● "VulnLoadFailed" - vulnerabilities load from scan report failed ● "Completed" - scan is completed ● "StartUpload" - internal status used for uploading scan ● "PendingStartUpload" - internal status used for uploading scan ● "ValidatingStartUpload" - internal status used for uploading scan ● "StartUpdate" - internal status used for updating scan ● "StartDeleteWithReports" - scan deleting is in progress ● "ReportError" - scan report download is failed ● "ReportRegenerating" - report regenerating started ● "ReportRegeneratingOnCloud" - report regenerating on Cloud ●"ReportRegeneratingRunning" - report regenerating ● "ReportRegeneratingError" - report regeneration failed ● "ReportRegeneratingCompleted" - report regeneration completed

/AppSpiderEnterprise/rest/v1/Scan/HasScanImported

Description Retrieves the scan status and import flag representing whether vulnerabilities have been imported from the completed scan

Parameters

Name

Type

Required

Description

scanId

guid[]

Y

The scan ID

Response Messages

Response status code

Reason

Description

200

Response contains scan status and import flag

400

ScanNotFound

Scan not found

json
1
{
2
  "type":"object",
3
  "properties": {
4
    "IsImported": {
5
      "type":"boolean",
6
      "required": true
7
    },
8
    "Status": {
9
      "type":["string", "null"],
10
      "required": true
11
    },  
12
    "IsSuccess": {
13
      "type":"boolean",
14
      "required": true
15
    },
16
    "ErrorMessage": {
17
      "type":["string", "null"],
18
      "required": true
19
    },
20
    "Reason": {
21
      "type":["string", "null"],
22
      "required": true
23
    }
24
  },
25
  "additionalProperties": false
26
}