Scan Management
Parameters No parameters
Response Messages
Response status code | Reason | Description |
---|---|---|
200 | Response contains the list of scans |
Response example:
{
"type":"object",
"properties": {
"Scans": {
"type":"array",
"items": {
"type":"object",
"properties": {
"Id": {
"type":"string",
"required": true
},
"EngineGroupId": {
"type":["string", "null"],
"required": true
},
"EngineId": {
"type":["string", "null"],
"required": true
},
"Token": {
"type":["string", "null"],
"required": true
},
"Status": {
"type":"integer",
"required": true
},
"StartTime": {
"type":["string", "null"],
"required": true
},
"WindowsScanStart": {
"type":["string", "null"],
"required": true
},
"WindowScanStop": {
"type":["string", "null"],
"required": true
},
"StopTime": {
"type":["string", "null"],
"required": true
},
"CompletionTime": {
"type":["string", "null"],
"required": true
},
"StartedBy": {
"type":["string", "null"],
"required": true
},
"ConfigId": {
"type":["string", "null"],
"required": true
},
"IsApproveRequired": {
"type":"boolean",
"required": true
},
"IsMonitoring": {
"type":"boolean",
"required": true
},
"IsUploaded": {
"type":"boolean",
"required": true
},
"IsImported": {
"type":"boolean",
"required": true
},
"Targets": {
"type":"array",
"items": {
"type":"object",
"properties": {
"Id": {
"type":"string",
"required": true
},
"Host": {
"type":"string",
"required": true
},
}
}
}
},
"additionalProperties": false
}
},
"IsSuccess": {
"type":"boolean"
"required": true
},
"ErrorMessage": {
"type":["string", "null"],
"required": true
},
"Reason": {
"type":["string", "null"],
"required": true
}
},
"additionalProperties": false
}
/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:
{
"type":"object",
"properties": {
"Scans": {
"type":"array",
"items": {
"type":"object",
"properties": {
"Id": {
"type":"string",
"required": true
},
"EngineGroupId": {
"type":["string", "null"],
"required": true
},
"EngineId": {
"type":["string", "null"],
"required": true
},
"Token": {
"type":["string", "null"],
"required": true
},
"Status": {
"type":"integer",
"required": true
},
"StartTime": {
"type":["string", "null"],
"required": true
},
"WindowsScanStart": {
"type":["string", "null"],
"required": true
},
"WindowScanStop": {
"type":["string", "null"],
"required": true
},
"StopTime": {
"type":["string", "null"],
"required": true
},
"CompletionTime": {
"type":["string", "null"],
"required": true
},
"StartedBy": {
"type":["string", "null"],
"required": true
},
"ConfigId": {
"type":["string", "null"],
"required": true
},
"IsApproveRequired": {
"type":"boolean",
"required": true
},
"IsMonitoring": {
"type":"boolean",
"required": true
},
"IsUploaded": {
"type":"boolean",
"required": true
},
"IsImported": {
"type":"boolean",
"required": true
},
"Targets": {
"type":"array",
"items": {
"type":"object",
"properties": {
"Id": {
"type":"string",
"required": true
},
"Host": {
"type":"string",
"required": true
},
}
}
}
},
"additionalProperties": false
}
},
"IsSuccess": {
"type":"boolean"
"required": true
},
"ErrorMessage": {
"type":["string", "null"],
"required": true
},
"Reason": {
"type":["string", "null"],
"required": true
}
},
"additionalProperties": false
}
/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:
{
"type":"object",
"properties": {
"Scans": {
"type":"array",
"items": {
"type":"object",
"properties": {
"Id": {
"type":"string",
"required": true
},
"EngineGroupId": {
"type":["string", "null"],
"required": true
},
"EngineId": {
"type":["string", "null"],
"required": true
},
"Token": {
"type":["string", "null"],
"required": true
},
"Status": {
"type":"integer",
"required": true
},
"StartTime": {
"type":["string", "null"],
"required": true
},
"WindowsScanStart": {
"type":["string", "null"],
"required": true
},
"WindowScanStop": {
"type":["string", "null"],
"required": true
},
"StopTime": {
"type":["string", "null"],
"required": true
},
"CompletionTime": {
"type":["string", "null"],
"required": true
},
"StartedBy": {
"type":["string", "null"],
"required": true
},
"ConfigId": {
"type":["string", "null"],
"required": true
},
"IsApproveRequired": {
"type":"boolean",
"required": true
},
"IsMonitoring": {
"type":"boolean",
"required": true
},
"IsUploaded": {
"type":"boolean",
"required": true
},
"IsImported": {
"type":"boolean",
"required": true
},
"Targets": {
"type":"array",
"items": {
"type":"object",
"properties": {
"Id": {
"type":"string",
"required": true
},
"Host": {
"type":"string",
"required": true
},
}
}
}
},
"additionalProperties": false
}
},
"IsSuccess": {
"type":"boolean"
"required": true
},
"ErrorMessage": {
"type":["string", "null"],
"required": true
},
"Reason": {
"type":["string", "null"],
"required": true
},
"TotalCount": {
"type": "integer",
"required": true
},
"TotalPages": {
"type": "integer",
"required": true
},
"Links": {
"type": "array",
"items": {
"Rel": {
"type":["string", "null"],
"required": true
},
"Href": {
"type":["string", "null"],
"required": true
}
}
}
},
},
"additionalProperties": false
}
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. |
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:
{
"type":"object",
"properties": {
"IsSuccess": {
"type":"boolean",
"required": true
},
"ErrorMessage": {
"type":["string", "null"],
"required": true
},
"Reason": {
"type":["string", "null"],
"required": true
}
},
"additionalProperties": false
}
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:
{
"type":"object",
"properties": {
"IsSuccess": {
"type":"boolean",
"required": true
},
"ErrorMessage": {
"type":["string", "null"],
"required": true
},
"Reason": {
"type":["string", "null"],
"required": true
}
},
"additionalProperties": false
}
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:
{
"type":"object",
"properties": {
"IsSuccess": {
"type":"boolean",
"required": true
},
"ErrorMessage": {
"type":["string", "null"],
"required": true
},
"Reason": {
"type":["string", "null"],
"required": true
}
},
"additionalProperties": false
}
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:
{
"type":"object",
"properties": {
"IsSuccess": {
"type":"boolean",
"required": true
},
"ErrorMessage": {
"type":["string", "null"],
"required": true
},
"Reason": {
"type":["string", "null"],
"required": true
}
},
"additionalProperties": false
}
Parameters No parameters
Response Messages
Response status code | Reason | Description |
---|---|---|
200 | Scans were paused |
Response example:
{
"type":"object",
"properties": {
"IsSuccess": {
"type":"boolean",
"required": true
},
"ErrorMessage": {
"type":["string", "null"],
"required": true
},
"Reason": {
"type":["string", "null"],
"required": true
}
},
"additionalProperties": false
}
Parameters No parameters
Response Messages
Response status code | Reason | Description |
---|---|---|
200 | Scans were resumed |
Response example:
{
"type":"object",
"properties": {
"IsSuccess": {
"type":"boolean",
"required": true
},
"ErrorMessage": {
"type":["string", "null"],
"required": true
},
"Reason": {
"type":["string", "null"],
"required": true
}
},
"additionalProperties": false
}
Parameters No parameters
Response Messages
Response status code | Reason | Description |
---|---|---|
200 | Scans were stopped |
Response example:
{
"type":"object",
"properties": {
"IsSuccess": {
"type":"boolean",
"required": true
},
"ErrorMessage": {
"type":["string", "null"],
"required": true
},
"Reason": {
"type":["string", "null"],
"required": true
}
},
"additionalProperties": false
}
Parameters No parameters
Response Messages
Response status code | Reason | Description |
---|---|---|
200 | Scans were all canceled |
Response example:
{
"type":"object",
"properties": {
"IsSuccess": {
"type":"boolean",
"required": true
},
"ErrorMessage": {
"type":["string", "null"],
"required": true
},
"Reason": {
"type":["string", "null"],
"required": true
}
},
"additionalProperties": false
}
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
{
"type":"object",
"properties": {
"Status": {
"type":["string", "null"],
"required": true
},
"IsSuccess": {
"type":"boolean",
"required": true
},
"ErrorMessage": {
"type":["string", "null"],
"required": true
},
"Reason": {
"type":["string", "null"],
"required": true
}
},
"additionalProperties": false
}
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:
{
"type":"object",
"properties": {
"Result": {
"type":"boolean",
"required": true
},
"IsSuccess": {
"type":"boolean",
"required": true
},
"ErrorMessage": {
"type":["string", "null"],
"required": true
},
"Reason": {
"type":["string", "null"],
"required": true
}
},
"additionalProperties": false
}
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:
{
"type":"object",
"properties": {
"Result": {
"type":"boolean",
"required": true
},
"IsSuccess": {
"type":"boolean",
"required": true
},
"ErrorMessage": {
"type":["string", "null"],
"required": true
},
"Reason": {
"type":["string", "null"],
"required": true
}
},
"additionalProperties": false
}
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:
{
"type":"object",
"properties": {
"Result": {
"type":"boolean",
"required": true
},
"IsSuccess": {
"type":"boolean",
"required": true
},
"ErrorMessage": {
"type":["string", "null"],
"required": true
},
"Reason": {
"type":["string", "null"],
"required": true
}
},
"additionalProperties": false
}
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:
{
"type":"object",
"properties": {
"Events": {
"type":"array",
"properties": {
"Type": {
"type":"string",
"required": true
},
"Date": {
"type":["string", "null"],
"required": true
},
"Message": {
"type":["string", "null"],
"required": true
}
},
"additionalProperties": false
}
},
"IsSuccess": {
"type":"boolean",
"required": true
},
"ErrorMessage": {
"type":["string", "null"],
"required": true
},
"Reason": {
"type":["string", "null"],
"required": true
}
},
"additionalProperties": flase
}
/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 |
{
"type":"object",
"properties": {
"IsImported": {
"type":"boolean",
"required": true
},
"Status": {
"type":["string", "null"],
"required": true
},
"IsSuccess": {
"type":"boolean",
"required": true
},
"ErrorMessage": {
"type":["string", "null"],
"required": true
},
"Reason": {
"type":["string", "null"],
"required": true
}
},
"additionalProperties": false
}