Scheduled Scan Management
/AppSpiderEnterprise/rest/v1/ScanSchedule/ScheduleScan
Description
Schedules a scan
Request Body
Name | Type | Required | Description |
---|---|---|---|
configId | guid[] | Y | Scan config ID |
startTime | DateTime | Y | Scan start time (UTC) |
stopTime | DateTime | N | Scan stop time (UTC) |
isRecurring | boolean | Y | Scan is recurring |
nextOurrence | DateTime | Y if IsRecurring is false. N if IsRecurring is true | Next ocurrence of scan |
recurrence | Recurrence object | N | Recurrence object. For more information see Recurrences Explained |
Request example:
{
"type":"object",
"properties": {
"configId": {
"type":"string",
"required": true
},
"startTime": {
"type":"string",
"required": true
},
"stopTime": {
"type":"string",
"required": false
},
"isRecurring": {
"type":"boolean",
"required": true
},
"nextOccurrence": {
"type":"string",
"required": false
},
"Recurrence": {
"type":["object", "null"],
"properties": {
"DayNumber": {
"type":"integer",
"required": true
},
"DuringWeekday": {
"type":"integer",
"required": true
},
"Month": {
"type":"integer",
"required": true
},
"WeekOfMonth": {
"type":"integer",
"required": true
},
"OccurrenceCount": {
"type":"integer",
"required": true
},
"End": {
"type":["string","null"],
"required": false
},
"Id": {
"type":"string",
"required": false
},
"Type": {
"type":"integer",
"required": true
},
"Repeat": {
"type":"integer",
"required": true
},
"Range": {
"type":"integer",
"required": true
},
}
}
},
}
Response Messages
Response status code | Reason | Description |
---|---|---|
200 | Scan config removed | |
400 | InvalidJsonSchema | Required parameters not provided |
400 | InvalidArguments | Scan config with ‘configId’ doesn’t exist in client. Scan config targets are not approved for user. Stop time must be greater than start date/time. Start time must be greater than current user time. IsRecurring is set to true(scan is recurring) but recurrence object is not provided. |
Response example:
{
"type":"object",
"properties": {
"ScanSchedule": {
"type":["object", "null"],
"properties": {
"Id": {
"type":"string",
"required": true
},
"ScheduledScanStatus": {
"type":"integer",
"required": true
},
"StartTime": {
"type":"string",
"required": true
},
"StopTime": {
"type":["string", "null"],
"required": true
},
"NextOccurrence": {
"type":["string","null"],
"required": true
},
"LastOccurrence": {
"type":["string", "null"],
"required": true
},
"ConfigId": {
"type":"string",
"required": true
},
"IsRecurring": {
"type":"boolean",
"required": true
},
"Recurrence": {
"type":["object", "null"],
"properties": {
"Id": {
"type":"string",
"required": true
},
"End": {
"type":["string","null"],
"required": true
},
"Type": {
"type":"integer",
"required": true
},
"DuringWeekday": {
"type":"integer",
"required": true
},
"Repeat": {
"type":"integer",
"required": true
},
"DayNumber": {
"type":"integer",
"required": true
},
"WeekOfMonth": {
"type":"integer",
"required": true
},
"Month": {
"type":"integer",
"required": true
},
"OccurrenceCount": {
"type":"integer",
"required": true
},
"Range": {
"type":"integer",
"required": true
}
},
"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/ScanSchedule/DeleteScanSchedules
Description
Deletes a scheduled scan from the client
Parameters
Name | Type | Required | Description |
---|---|---|---|
scheduleIds | guid[] | Y | Scheduled scan IDs |
Response Messages
Response status code | Reason | Description |
---|---|---|
200 | Scheduled scan removed | |
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
}
/AppSpiderEnterprise/rest/v1/ScanSchedule/GetScanSchedules
Description
Retrieves scheduled scan list for the client
Parameters No parameters
Response Messages
Response status code | Reason | Description |
---|---|---|
200 | Response contains the list of scheduled scans |
Response example:
{
"type":"object",
"properties": {
"ScanSchedules": {
"type":"array",
"items": {
"type":"object",
"properties": {
"Id": {
"type":"string",
"required": true
},
"ScheduledScanStatus": {
"type":"integer",
"required": true
},
"StartTime": {
"type":"string",
"required": true
},
"StopTime": {
"type":["string", "null"],
"required": true
},
"NextOccurrence": {
"type":["string","null"],
"required": true
},
"LastOccurrence": {
"type":["string", "null"],
"required": true
},
"ConfigId": {
"type":"string",
"required": true
},
"IsRecurring": {
"type":"boolean",
"required": true
},
"Recurrence": {
"type":["object", "null"],
"properties": {
"Id": {
"type":"string",
"required": true
},
"End": {
"type":["string","null"],
"required": true
},
"Type": {
"type":"integer",
"required": true
},
"DuringWeekday": {
"type":"integer",
"required": true
},
"Repeat": {
"type":"integer",
"required": true
},
"DayNumber": {
"type":"integer",
"required": true
},
"WeekOfMonth": {
"type":"integer",
"required": true
},
"Month": {
"type":"integer",
"required": true
},
"OccurrenceCount": {
"type":"integer",
"required": true
},
"Range": {
"type":"integer",
"required": true
}
},
"required": true,
"additionalProperties": false
}
}
},
"IsSuccess": {
"type":"boolean",
"required": true
},
"ErrorMessage": {
"type":["string", "null"],
"required": true
},
"Reason": {
"type":["string", "null"],
"required": true
}
},
"additionalProperties": false
}