# Deep Security Manager REST API

## Name: ScheduledTaskObject

Details of a scheduled task.

JSON Example:
    {"ScheduledTaskObject":
     {
       "backupTaskParameters": BackupTaskParameters,
       "checkForSecurityUpdatesTaskParameters": CheckForSecurityUpdatesTaskParameters,
       "discoverComputersTaskParameters": DiscoverComputersTaskParameters,
       "generateReportTaskParameters": GenerateReportTaskParameters,
       "iD": Number,
       "lastRunTime": Number,
       "name": String,
       "nextRunTime": Number,
       "runScriptTaskParameters": RunScriptTaskParameters,
       "scanForIntegrityChangesTaskParameters": ScanForIntegrityChangesTaskParameters,
       "scanForMalwareTaskParameters": ScanForMalwareTaskParameters,
       "scanForOpenPortsTaskParameters": ScanForOpenPortsTaskParameters,
       "scanForRecommendationsTaskParameters": ScanForRecommendationsTaskParameters,
       "schedule": Schedule,
       "sendAlertSummaryTaskParameters": SendAlertSummaryTaskParameters,
       "sendPolicyTaskParameters": SendPolicyTaskParameters,
       "synchronizeCloudAccountTaskParameters": SynchronizeCloudAccountTaskParameters,
       "synchronizeDirectoryTaskParameters": SynchronizeDirectoryTaskParameters,
       "synchronizeVCenterTaskParameters": SynchronizeVCenterTaskParameters,
       "timeZone": String,
       "type": 'backup' | 'scan-for-open-ports' | 'send-alert-summary' | 'discover-computers' | 'run-script' | 'send-policy' | 'generate-report' | 'synchronize-directory' | 'synchronize-users' | 'scan-for-recommendations' | 'synchronize-vcenter' | 'scan-for-integrity-changes' | 'scan-for-malware' | 'check-for-security-updates' | 'synchronize-cloud-account' | 'check-for-software-updates' | 'update-suspicious-objects-list',
       "updateSuspiciousObjectsListTaskParameters": UpdateSuspiciousObjectsListTaskParameters,
     }
    }

Elements
Name | Type | Required | Default Value | Description
--- | --- | --- | --- | ---
backupTaskParameters | BackupTaskParameters | No | `` | Get the backup task parameters.
checkForSecurityUpdatesTaskParameters | CheckForSecurityUpdatesTaskParameters | No | `` | Get the check for security updates task parameters.
discoverComputersTaskParameters | DiscoverComputersTaskParameters | No | `` | Get the discover computers task parameters.
generateReportTaskParameters | GenerateReportTaskParameters | No | `` | Get the generate report task parameters.
iD | Number | No | `` | Get the task's identifier.
lastRunTime | Number | No | `` | Get the last run time for this task. This system value is provided for information purposes and cannot be set through the API. Attempts to set or change this read-only value through the API will be ignored.
name | String | No | `` | Get the name to use when displaying this task.
nextRunTime | Number | No | `` | Get the next run time for this task. This system value is provided for information purposes and cannot be set through the API. Attempts to set or change this read-only value through the API will be ignored.
runScriptTaskParameters | RunScriptTaskParameters | No | `` | Get the run script task parameters.
scanForIntegrityChangesTaskParameters | ScanForIntegrityChangesTaskParameters | No | `` | Get the scan for integrity changes task parameters.
scanForMalwareTaskParameters | ScanForMalwareTaskParameters | No | `` | Get the scan for malware task parameters.
scanForOpenPortsTaskParameters | ScanForOpenPortsTaskParameters | No | `` | Get the scan for open ports task parameters.
scanForRecommendationsTaskParameters | ScanForRecommendationsTaskParameters | No | `` | Get the scan for recommendations task parameters.
schedule | Schedule | No | `` | Get the schedule details for this task.
sendAlertSummaryTaskParameters | SendAlertSummaryTaskParameters | No | `` | Get the send alert summary task parameters.
sendPolicyTaskParameters | SendPolicyTaskParameters | No | `` | Get the send policy task parameters.
synchronizeCloudAccountTaskParameters | SynchronizeCloudAccountTaskParameters | No | `` | Get the synchronize cloud account task parameters.
synchronizeDirectoryTaskParameters | SynchronizeDirectoryTaskParameters | No | `` | Get the synchronize directory task parameters.
synchronizeVCenterTaskParameters | SynchronizeVCenterTaskParameters | No | `` | Get the synchronize vcenter task parameters.
timeZone | String | No | `` | Get the task time zone. Deep Security will attempt to parse the time zone identifier you provide and translate it into an internal identifier. When you retrieve the time zone from Deep Security, you will get one of the IANA Time Zone Database identifiers. If you don't provide a time zone, the system will set the task time zone to the system local time zone. If you provide a time zone that Deep Security can't parse, the task time zone will be set to GMT.
type | 'backup' | 'scan-for-open-ports' | 'send-alert-summary' | 'discover-computers' | 'run-script' | 'send-policy' | 'generate-report' | 'synchronize-directory' | 'synchronize-users' | 'scan-for-recommendations' | 'synchronize-vcenter' | 'scan-for-integrity-changes' | 'scan-for-malware' | 'check-for-security-updates' | 'synchronize-cloud-account' | 'check-for-software-updates' | 'update-suspicious-objects-list' | No | `` | Get the task's type.
updateSuspiciousObjectsListTaskParameters | UpdateSuspiciousObjectsListTaskParameters | No | `` | Get the update suspicious objects list task parameters.

Copyright © 2017 Trend Micro Inc. All Rights Reserved.