Describe a Scheduled Task
Describe a scheduled task by ID.
ScheduledTasksApi.describeScheduledTask([param1, param2, ...])
ScheduledTasksApi.describe_scheduled_task([param1, param2, ...])
ScheduledTasksApi.describeScheduledTask([param1, param2, ...])
successful operation
Not authorized to view scheduled tasks.
The scheduled task does not exist.
- Java
- Python
- JavaScript
import com.trendmicro.deepsecurity.ApiClient; import com.trendmicro.deepsecurity.Configuration; import com.trendmicro.deepsecurity.auth.ApiKeyAuth; import com.trendmicro.deepsecurity.auth.ApiKeyAuth; import com.trendmicro.deepsecurity.ApiException; import com.trendmicro.deepsecurity.api.ScheduledTasksApi; import com.trendmicro.deepsecurity.model.ScheduledTask; public class DescribeScheduledTaskExample { public static void main(String[] args) { // Setup ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("YOUR HOST"); // Authentication ApiKeyAuth Legacy API Key = (ApiKeyAuth) defaultClient.getAuthentication("Legacy API Key"); Legacy API Key.setApiKey("YOUR API KEY"); try { defaultClient.trustAllCertificates(false); } catch (Exception e) { System.err.println("An exception occurred when calling ApiClient.trustAllCertificates"); e.printStackTrace(); } ApiKeyAuth Trend Micro Cloud One API Key = (ApiKeyAuth) defaultClient.getAuthentication("Trend Micro Cloud One API Key"); Trend Micro Cloud One API Key.setApiKey("YOUR API KEY"); try { defaultClient.trustAllCertificates(false); } catch (Exception e) { System.err.println("An exception occurred when calling ApiClient.trustAllCertificates"); e.printStackTrace(); } // Initialization // Set Any Required Values ScheduledTasksApi instance = new ScheduledTasksApi(); Integer scheduledTaskID = 1; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours ScheduledTask result = instance.describeScheduledTask(scheduledTaskID, apiVersion); System.out.println(result); } catch (ApiException e) { System.err.println("An exception occurred when calling ScheduledTasksApi.describeScheduledTask"); e.printStackTrace(); } } }
- 200
{- "name": "string",
- "type": "scan-for-open-ports",
- "scheduleDetails": {
- "timeZone": "string",
- "recurrenceType": "none",
- "recurrenceCount": 0,
- "hourlyScheduleParameters": {
- "minutesPastTheHour": "0"
}, - "dailyScheduleParameters": {
- "startTime": 0,
- "frequencyType": "everyday",
- "customInterval": 0
}, - "weeklyScheduleParameters": {
- "startTime": 0,
- "interval": 0,
- "days": [
- "sunday"
]
}, - "monthlyScheduleParameters": {
- "startTime": 0,
- "frequencyType": "day-of-month",
- "dayOfMonth": 0,
- "weekOfMonth": "first",
- "dayOfWeek": "sunday",
- "months": [
- "january"
]
}, - "onceOnlyScheduleParameters": {
- "startTime": 0
}
}, - "enabled": true,
- "lastRunTime": 0,
- "nextRunTime": 0,
- "runNow": true,
- "scanForOpenPortsTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "sendAlertSummaryTaskParameters": {
- "recipients": {
- "allAdministratorsAndContacts": true,
- "administratorIDs": [
- 0
], - "contactIDs": [
- 0
]
}
}, - "runScriptTaskParameters": {
- "filename": "string"
}, - "sendPolicyTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "generateReportTaskParameters": {
- "reportTemplateID": 0,
- "format": "pdf",
- "classification": "blank",
- "recipients": {
- "allAdministratorsAndContacts": true,
- "administratorIDs": [
- 0
], - "contactIDs": [
- 0
]
}, - "timeRange": {
- "units": "hour",
- "value": 0
}, - "tagFilter": {
- "type": "all",
- "tags": [
- "string"
]
}, - "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "synchronizeDirectoryTaskParameters": {
- "computerGroupID": 0
}, - "scanForRecommendationsTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "synchronizeVCenterTaskParameters": {
- "computerGroupID": 0
}, - "scanForIntegrityChangesTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "trustedComputers": "all-computers"
}, - "scanForMalwareTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "timeout": "never"
}, - "checkForSecurityUpdatesTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "timeout": "never"
}, - "synchronizeCloudAccountTaskParameters": {
- "computerGroupID": 0
}, - "updateSuspiciousObjectsListTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "scheduledAgentUpgradeTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "targetAgentVersion": "string"
}, - "ID": 0
}
Modify a Scheduled Task
Modify a scheduled task by ID. Any unset elements will be left unchanged.
ScheduledTasksApi.modifyScheduledTask([param1, param2, ...])
ScheduledTasksApi.modify_scheduled_task([param1, param2, ...])
ScheduledTasksApi.modifyScheduledTask([param1, param2, ...])
path Parameters
header Parameters
Request Body schema: application/json
The settings of the scheduled task to modify.
successful operation
Not authorized to modify scheduled tasks or the requested modification is not permitted.
The scheduled task does not exist.
- Payload
- Java
- Python
- JavaScript
{- "name": "string",
- "type": "scan-for-open-ports",
- "scheduleDetails": {
- "timeZone": "string",
- "recurrenceType": "none",
- "recurrenceCount": 0,
- "hourlyScheduleParameters": {
- "minutesPastTheHour": "0"
}, - "dailyScheduleParameters": {
- "startTime": 0,
- "frequencyType": "everyday",
- "customInterval": 0
}, - "weeklyScheduleParameters": {
- "startTime": 0,
- "interval": 0,
- "days": [
- "sunday"
]
}, - "monthlyScheduleParameters": {
- "startTime": 0,
- "frequencyType": "day-of-month",
- "dayOfMonth": 0,
- "weekOfMonth": "first",
- "dayOfWeek": "sunday",
- "months": [
- "january"
]
}, - "onceOnlyScheduleParameters": {
- "startTime": 0
}
}, - "enabled": true,
- "lastRunTime": 0,
- "nextRunTime": 0,
- "runNow": true,
- "scanForOpenPortsTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "sendAlertSummaryTaskParameters": {
- "recipients": {
- "allAdministratorsAndContacts": true,
- "administratorIDs": [
- 0
], - "contactIDs": [
- 0
]
}
}, - "runScriptTaskParameters": {
- "filename": "string"
}, - "sendPolicyTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "generateReportTaskParameters": {
- "reportTemplateID": 0,
- "format": "pdf",
- "classification": "blank",
- "recipients": {
- "allAdministratorsAndContacts": true,
- "administratorIDs": [
- 0
], - "contactIDs": [
- 0
]
}, - "timeRange": {
- "units": "hour",
- "value": 0
}, - "tagFilter": {
- "type": "all",
- "tags": [
- "string"
]
}, - "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "synchronizeDirectoryTaskParameters": {
- "computerGroupID": 0
}, - "scanForRecommendationsTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "synchronizeVCenterTaskParameters": {
- "computerGroupID": 0
}, - "scanForIntegrityChangesTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "trustedComputers": "all-computers"
}, - "scanForMalwareTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "timeout": "never"
}, - "checkForSecurityUpdatesTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "timeout": "never"
}, - "synchronizeCloudAccountTaskParameters": {
- "computerGroupID": 0
}, - "updateSuspiciousObjectsListTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "scheduledAgentUpgradeTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "targetAgentVersion": "string"
}
}
- 200
{- "name": "string",
- "type": "scan-for-open-ports",
- "scheduleDetails": {
- "timeZone": "string",
- "recurrenceType": "none",
- "recurrenceCount": 0,
- "hourlyScheduleParameters": {
- "minutesPastTheHour": "0"
}, - "dailyScheduleParameters": {
- "startTime": 0,
- "frequencyType": "everyday",
- "customInterval": 0
}, - "weeklyScheduleParameters": {
- "startTime": 0,
- "interval": 0,
- "days": [
- "sunday"
]
}, - "monthlyScheduleParameters": {
- "startTime": 0,
- "frequencyType": "day-of-month",
- "dayOfMonth": 0,
- "weekOfMonth": "first",
- "dayOfWeek": "sunday",
- "months": [
- "january"
]
}, - "onceOnlyScheduleParameters": {
- "startTime": 0
}
}, - "enabled": true,
- "lastRunTime": 0,
- "nextRunTime": 0,
- "runNow": true,
- "scanForOpenPortsTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "sendAlertSummaryTaskParameters": {
- "recipients": {
- "allAdministratorsAndContacts": true,
- "administratorIDs": [
- 0
], - "contactIDs": [
- 0
]
}
}, - "runScriptTaskParameters": {
- "filename": "string"
}, - "sendPolicyTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "generateReportTaskParameters": {
- "reportTemplateID": 0,
- "format": "pdf",
- "classification": "blank",
- "recipients": {
- "allAdministratorsAndContacts": true,
- "administratorIDs": [
- 0
], - "contactIDs": [
- 0
]
}, - "timeRange": {
- "units": "hour",
- "value": 0
}, - "tagFilter": {
- "type": "all",
- "tags": [
- "string"
]
}, - "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "synchronizeDirectoryTaskParameters": {
- "computerGroupID": 0
}, - "scanForRecommendationsTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "synchronizeVCenterTaskParameters": {
- "computerGroupID": 0
}, - "scanForIntegrityChangesTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "trustedComputers": "all-computers"
}, - "scanForMalwareTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "timeout": "never"
}, - "checkForSecurityUpdatesTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "timeout": "never"
}, - "synchronizeCloudAccountTaskParameters": {
- "computerGroupID": 0
}, - "updateSuspiciousObjectsListTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "scheduledAgentUpgradeTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "targetAgentVersion": "string"
}, - "ID": 0
}
Delete a Scheduled Task
Delete a scheduled task by ID.
ScheduledTasksApi.deleteScheduledTask([param1, param2, ...])
ScheduledTasksApi.delete_scheduled_task([param1, param2, ...])
ScheduledTasksApi.deleteScheduledTask([param1, param2, ...])
Request is successful.
Not authorized to delete scheduled tasks.
- Java
- Python
- JavaScript
import com.trendmicro.deepsecurity.ApiClient; import com.trendmicro.deepsecurity.Configuration; import com.trendmicro.deepsecurity.auth.ApiKeyAuth; import com.trendmicro.deepsecurity.auth.ApiKeyAuth; import com.trendmicro.deepsecurity.ApiException; import com.trendmicro.deepsecurity.api.ScheduledTasksApi; public class DeleteScheduledTaskExample { public static void main(String[] args) { // Setup ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("YOUR HOST"); // Authentication ApiKeyAuth Legacy API Key = (ApiKeyAuth) defaultClient.getAuthentication("Legacy API Key"); Legacy API Key.setApiKey("YOUR API KEY"); try { defaultClient.trustAllCertificates(false); } catch (Exception e) { System.err.println("An exception occurred when calling ApiClient.trustAllCertificates"); e.printStackTrace(); } ApiKeyAuth Trend Micro Cloud One API Key = (ApiKeyAuth) defaultClient.getAuthentication("Trend Micro Cloud One API Key"); Trend Micro Cloud One API Key.setApiKey("YOUR API KEY"); try { defaultClient.trustAllCertificates(false); } catch (Exception e) { System.err.println("An exception occurred when calling ApiClient.trustAllCertificates"); e.printStackTrace(); } // Initialization // Set Any Required Values ScheduledTasksApi instance = new ScheduledTasksApi(); Integer scheduledTaskID = 1; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours instance.deleteScheduledTask(scheduledTaskID, apiVersion); } catch (ApiException e) { System.err.println("An exception occurred when calling ScheduledTasksApi.deleteScheduledTask"); e.printStackTrace(); } } }
List Scheduled Tasks
Lists all scheduled tasks.
ScheduledTasksApi.listScheduledTasks([param1, param2, ...])
ScheduledTasksApi.list_scheduled_tasks([param1, param2, ...])
ScheduledTasksApi.listScheduledTasks([param1, param2, ...])
successful operation
Not authorized to view scheduled tasks.
- Java
- Python
- JavaScript
import com.trendmicro.deepsecurity.ApiClient; import com.trendmicro.deepsecurity.Configuration; import com.trendmicro.deepsecurity.auth.ApiKeyAuth; import com.trendmicro.deepsecurity.auth.ApiKeyAuth; import com.trendmicro.deepsecurity.ApiException; import com.trendmicro.deepsecurity.api.ScheduledTasksApi; import com.trendmicro.deepsecurity.model.ScheduledTasks; public class ListScheduledTasksExample { public static void main(String[] args) { // Setup ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("YOUR HOST"); // Authentication ApiKeyAuth Legacy API Key = (ApiKeyAuth) defaultClient.getAuthentication("Legacy API Key"); Legacy API Key.setApiKey("YOUR API KEY"); try { defaultClient.trustAllCertificates(false); } catch (Exception e) { System.err.println("An exception occurred when calling ApiClient.trustAllCertificates"); e.printStackTrace(); } ApiKeyAuth Trend Micro Cloud One API Key = (ApiKeyAuth) defaultClient.getAuthentication("Trend Micro Cloud One API Key"); Trend Micro Cloud One API Key.setApiKey("YOUR API KEY"); try { defaultClient.trustAllCertificates(false); } catch (Exception e) { System.err.println("An exception occurred when calling ApiClient.trustAllCertificates"); e.printStackTrace(); } // Initialization // Set Any Required Values ScheduledTasksApi instance = new ScheduledTasksApi(); String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours ScheduledTasks result = instance.listScheduledTasks(apiVersion); System.out.println(result); } catch (ApiException e) { System.err.println("An exception occurred when calling ScheduledTasksApi.listScheduledTasks"); e.printStackTrace(); } } }
- 200
{- "scheduledTasks": [
- {
- "name": "string",
- "type": "scan-for-open-ports",
- "scheduleDetails": {
- "timeZone": "string",
- "recurrenceType": "none",
- "recurrenceCount": 0,
- "hourlyScheduleParameters": {
- "minutesPastTheHour": "0"
}, - "dailyScheduleParameters": {
- "startTime": 0,
- "frequencyType": "everyday",
- "customInterval": 0
}, - "weeklyScheduleParameters": {
- "startTime": 0,
- "interval": 0,
- "days": [
- "sunday"
]
}, - "monthlyScheduleParameters": {
- "startTime": 0,
- "frequencyType": "day-of-month",
- "dayOfMonth": 0,
- "weekOfMonth": "first",
- "dayOfWeek": "sunday",
- "months": [
- "january"
]
}, - "onceOnlyScheduleParameters": {
- "startTime": 0
}
}, - "enabled": true,
- "lastRunTime": 0,
- "nextRunTime": 0,
- "runNow": true,
- "scanForOpenPortsTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "sendAlertSummaryTaskParameters": {
- "recipients": {
- "allAdministratorsAndContacts": true,
- "administratorIDs": [
- 0
], - "contactIDs": [
- 0
]
}
}, - "runScriptTaskParameters": {
- "filename": "string"
}, - "sendPolicyTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "generateReportTaskParameters": {
- "reportTemplateID": 0,
- "format": "pdf",
- "classification": "blank",
- "recipients": {
- "allAdministratorsAndContacts": true,
- "administratorIDs": [
- 0
], - "contactIDs": [
- 0
]
}, - "timeRange": {
- "units": "hour",
- "value": 0
}, - "tagFilter": {
- "type": "all",
- "tags": [
- "string"
]
}, - "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "synchronizeDirectoryTaskParameters": {
- "computerGroupID": 0
}, - "scanForRecommendationsTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "synchronizeVCenterTaskParameters": {
- "computerGroupID": 0
}, - "scanForIntegrityChangesTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "trustedComputers": "all-computers"
}, - "scanForMalwareTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "timeout": "never"
}, - "checkForSecurityUpdatesTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "timeout": "never"
}, - "synchronizeCloudAccountTaskParameters": {
- "computerGroupID": 0
}, - "updateSuspiciousObjectsListTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "scheduledAgentUpgradeTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "targetAgentVersion": "string"
}, - "ID": 0
}
]
}
Create a Scheduled Task
Create a new scheduled task.
ScheduledTasksApi.createScheduledTask([param1, param2, ...])
ScheduledTasksApi.create_scheduled_task([param1, param2, ...])
ScheduledTasksApi.createScheduledTask([param1, param2, ...])
header Parameters
Request Body schema: application/json
The settings of the new scheduled task.
successful operation
Not authorized to create scheduled tasks.
- Payload
- Java
- Python
- JavaScript
{- "name": "string",
- "type": "scan-for-open-ports",
- "scheduleDetails": {
- "timeZone": "string",
- "recurrenceType": "none",
- "recurrenceCount": 0,
- "hourlyScheduleParameters": {
- "minutesPastTheHour": "0"
}, - "dailyScheduleParameters": {
- "startTime": 0,
- "frequencyType": "everyday",
- "customInterval": 0
}, - "weeklyScheduleParameters": {
- "startTime": 0,
- "interval": 0,
- "days": [
- "sunday"
]
}, - "monthlyScheduleParameters": {
- "startTime": 0,
- "frequencyType": "day-of-month",
- "dayOfMonth": 0,
- "weekOfMonth": "first",
- "dayOfWeek": "sunday",
- "months": [
- "january"
]
}, - "onceOnlyScheduleParameters": {
- "startTime": 0
}
}, - "enabled": true,
- "lastRunTime": 0,
- "nextRunTime": 0,
- "runNow": true,
- "scanForOpenPortsTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "sendAlertSummaryTaskParameters": {
- "recipients": {
- "allAdministratorsAndContacts": true,
- "administratorIDs": [
- 0
], - "contactIDs": [
- 0
]
}
}, - "runScriptTaskParameters": {
- "filename": "string"
}, - "sendPolicyTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "generateReportTaskParameters": {
- "reportTemplateID": 0,
- "format": "pdf",
- "classification": "blank",
- "recipients": {
- "allAdministratorsAndContacts": true,
- "administratorIDs": [
- 0
], - "contactIDs": [
- 0
]
}, - "timeRange": {
- "units": "hour",
- "value": 0
}, - "tagFilter": {
- "type": "all",
- "tags": [
- "string"
]
}, - "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "synchronizeDirectoryTaskParameters": {
- "computerGroupID": 0
}, - "scanForRecommendationsTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "synchronizeVCenterTaskParameters": {
- "computerGroupID": 0
}, - "scanForIntegrityChangesTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "trustedComputers": "all-computers"
}, - "scanForMalwareTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "timeout": "never"
}, - "checkForSecurityUpdatesTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "timeout": "never"
}, - "synchronizeCloudAccountTaskParameters": {
- "computerGroupID": 0
}, - "updateSuspiciousObjectsListTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "scheduledAgentUpgradeTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "targetAgentVersion": "string"
}
}
- 200
{- "name": "string",
- "type": "scan-for-open-ports",
- "scheduleDetails": {
- "timeZone": "string",
- "recurrenceType": "none",
- "recurrenceCount": 0,
- "hourlyScheduleParameters": {
- "minutesPastTheHour": "0"
}, - "dailyScheduleParameters": {
- "startTime": 0,
- "frequencyType": "everyday",
- "customInterval": 0
}, - "weeklyScheduleParameters": {
- "startTime": 0,
- "interval": 0,
- "days": [
- "sunday"
]
}, - "monthlyScheduleParameters": {
- "startTime": 0,
- "frequencyType": "day-of-month",
- "dayOfMonth": 0,
- "weekOfMonth": "first",
- "dayOfWeek": "sunday",
- "months": [
- "january"
]
}, - "onceOnlyScheduleParameters": {
- "startTime": 0
}
}, - "enabled": true,
- "lastRunTime": 0,
- "nextRunTime": 0,
- "runNow": true,
- "scanForOpenPortsTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "sendAlertSummaryTaskParameters": {
- "recipients": {
- "allAdministratorsAndContacts": true,
- "administratorIDs": [
- 0
], - "contactIDs": [
- 0
]
}
}, - "runScriptTaskParameters": {
- "filename": "string"
}, - "sendPolicyTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "generateReportTaskParameters": {
- "reportTemplateID": 0,
- "format": "pdf",
- "classification": "blank",
- "recipients": {
- "allAdministratorsAndContacts": true,
- "administratorIDs": [
- 0
], - "contactIDs": [
- 0
]
}, - "timeRange": {
- "units": "hour",
- "value": 0
}, - "tagFilter": {
- "type": "all",
- "tags": [
- "string"
]
}, - "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "synchronizeDirectoryTaskParameters": {
- "computerGroupID": 0
}, - "scanForRecommendationsTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "synchronizeVCenterTaskParameters": {
- "computerGroupID": 0
}, - "scanForIntegrityChangesTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "trustedComputers": "all-computers"
}, - "scanForMalwareTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "timeout": "never"
}, - "checkForSecurityUpdatesTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "timeout": "never"
}, - "synchronizeCloudAccountTaskParameters": {
- "computerGroupID": 0
}, - "updateSuspiciousObjectsListTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "scheduledAgentUpgradeTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "targetAgentVersion": "string"
}, - "ID": 0
}
Search Scheduled Tasks
Search for scheduled tasks using optional filters.
ScheduledTasksApi.searchScheduledTasks([param1, param2, ...])
ScheduledTasksApi.search_scheduled_tasks([param1, param2, ...])
ScheduledTasksApi.searchScheduledTasks([param1, param2, ...])
header Parameters
Request Body schema: application/json
A collection of options used to filter the search results.
successful operation
Not authorized to view scheduled tasks.
- Payload
- Java
- Python
- JavaScript
{- "maxItems": 0,
- "searchCriteria": [
- {
- "fieldName": "string",
- "booleanTest": true,
- "numericTest": "less-than",
- "numericValue": 0,
- "numericValueList": [
- 0
], - "stringTest": "equal",
- "stringValue": "string",
- "stringWildcards": true,
- "choiceTest": "equal",
- "choiceValue": "string",
- "firstDateValue": 0,
- "firstDateInclusive": true,
- "lastDateValue": 0,
- "lastDateInclusive": true,
- "nullTest": true,
- "versionTest": "less-than",
- "versionValue": "string",
- "idValue": 0,
- "idTest": "less-than",
- "idValueList": [
- 0
]
}
], - "sortByObjectID": true
}
- 200
{- "scheduledTasks": [
- {
- "name": "string",
- "type": "scan-for-open-ports",
- "scheduleDetails": {
- "timeZone": "string",
- "recurrenceType": "none",
- "recurrenceCount": 0,
- "hourlyScheduleParameters": {
- "minutesPastTheHour": "0"
}, - "dailyScheduleParameters": {
- "startTime": 0,
- "frequencyType": "everyday",
- "customInterval": 0
}, - "weeklyScheduleParameters": {
- "startTime": 0,
- "interval": 0,
- "days": [
- "sunday"
]
}, - "monthlyScheduleParameters": {
- "startTime": 0,
- "frequencyType": "day-of-month",
- "dayOfMonth": 0,
- "weekOfMonth": "first",
- "dayOfWeek": "sunday",
- "months": [
- "january"
]
}, - "onceOnlyScheduleParameters": {
- "startTime": 0
}
}, - "enabled": true,
- "lastRunTime": 0,
- "nextRunTime": 0,
- "runNow": true,
- "scanForOpenPortsTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "sendAlertSummaryTaskParameters": {
- "recipients": {
- "allAdministratorsAndContacts": true,
- "administratorIDs": [
- 0
], - "contactIDs": [
- 0
]
}
}, - "runScriptTaskParameters": {
- "filename": "string"
}, - "sendPolicyTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "generateReportTaskParameters": {
- "reportTemplateID": 0,
- "format": "pdf",
- "classification": "blank",
- "recipients": {
- "allAdministratorsAndContacts": true,
- "administratorIDs": [
- 0
], - "contactIDs": [
- 0
]
}, - "timeRange": {
- "units": "hour",
- "value": 0
}, - "tagFilter": {
- "type": "all",
- "tags": [
- "string"
]
}, - "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "synchronizeDirectoryTaskParameters": {
- "computerGroupID": 0
}, - "scanForRecommendationsTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "synchronizeVCenterTaskParameters": {
- "computerGroupID": 0
}, - "scanForIntegrityChangesTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "trustedComputers": "all-computers"
}, - "scanForMalwareTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "timeout": "never"
}, - "checkForSecurityUpdatesTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "timeout": "never"
}, - "synchronizeCloudAccountTaskParameters": {
- "computerGroupID": 0
}, - "updateSuspiciousObjectsListTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}
}, - "scheduledAgentUpgradeTaskParameters": {
- "computerFilter": {
- "type": "computer",
- "computerID": 0,
- "computerGroupID": 0,
- "policyID": 0,
- "smartFolderID": 0
}, - "targetAgentVersion": "string"
}, - "ID": 0
}
]
}