Describe an Event Based Task
Describe an event based task by ID.
EventBasedTasksApi.describeEventBasedTask([param1, param2, ...])
EventBasedTasksApi.describe_event_based_task([param1, param2, ...])
EventBasedTasksApi.describeEventBasedTask([param1, param2, ...])
successful operation
Not authorized to view scheduled tasks.
The event based 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.EventBasedTasksApi; import com.trendmicro.deepsecurity.model.EventBasedTask; public class DescribeEventBasedTaskExample { 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 EventBasedTasksApi instance = new EventBasedTasksApi(); Integer eventBasedTaskID = 1; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours EventBasedTask result = instance.describeEventBasedTask(eventBasedTaskID, apiVersion); System.out.println(result); } catch (ApiException e) { System.err.println("An exception occurred when calling EventBasedTasksApi.describeEventBasedTask"); e.printStackTrace(); } } }
- 200
{- "name": "string",
- "type": "computer-created-by-system",
- "enabled": true,
- "lastRunTime": 0,
- "actions": [
- {
- "type": "activate",
- "parameterValue": 0
}
], - "conditions": [
- {
- "field": "hostname",
- "key": "string",
- "value": "string"
}
], - "ID": 0
}
Modify an Event Based Task
Modify an event based task by ID. Any unset elements will be left unchanged.
EventBasedTasksApi.modifyEventBasedTask([param1, param2, ...])
EventBasedTasksApi.modify_event_based_task([param1, param2, ...])
EventBasedTasksApi.modifyEventBasedTask([param1, param2, ...])
path Parameters
header Parameters
Request Body schema: application/json
The settings of the event based task to modify.
successful operation
Not authorized to modify event based tasks or the requested modification is not permitted.
The event based task does not exist.
- Payload
- Java
- Python
- JavaScript
{- "name": "string",
- "type": "computer-created-by-system",
- "enabled": true,
- "lastRunTime": 0,
- "actions": [
- {
- "type": "activate",
- "parameterValue": 0
}
], - "conditions": [
- {
- "field": "hostname",
- "key": "string",
- "value": "string"
}
]
}
- 200
{- "name": "string",
- "type": "computer-created-by-system",
- "enabled": true,
- "lastRunTime": 0,
- "actions": [
- {
- "type": "activate",
- "parameterValue": 0
}
], - "conditions": [
- {
- "field": "hostname",
- "key": "string",
- "value": "string"
}
], - "ID": 0
}
Delete an Event Based Task
Delete an event based task by ID.
EventBasedTasksApi.deleteEventBasedTask([param1, param2, ...])
EventBasedTasksApi.delete_event_based_task([param1, param2, ...])
EventBasedTasksApi.deleteEventBasedTask([param1, param2, ...])
Request is successful.
Not authorized to delete event based 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.EventBasedTasksApi; public class DeleteEventBasedTaskExample { 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 EventBasedTasksApi instance = new EventBasedTasksApi(); Integer eventBasedTaskID = 1; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours instance.deleteEventBasedTask(eventBasedTaskID, apiVersion); } catch (ApiException e) { System.err.println("An exception occurred when calling EventBasedTasksApi.deleteEventBasedTask"); e.printStackTrace(); } } }
List Event Based Tasks
Lists all event based tasks.
EventBasedTasksApi.listEventBasedTasks([param1, param2, ...])
EventBasedTasksApi.list_event_based_tasks([param1, param2, ...])
EventBasedTasksApi.listEventBasedTasks([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.EventBasedTasksApi; import com.trendmicro.deepsecurity.model.EventBasedTasks; public class ListEventBasedTasksExample { 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 EventBasedTasksApi instance = new EventBasedTasksApi(); String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours EventBasedTasks result = instance.listEventBasedTasks(apiVersion); System.out.println(result); } catch (ApiException e) { System.err.println("An exception occurred when calling EventBasedTasksApi.listEventBasedTasks"); e.printStackTrace(); } } }
- 200
{- "eventBasedTasks": [
- {
- "name": "string",
- "type": "computer-created-by-system",
- "enabled": true,
- "lastRunTime": 0,
- "actions": [
- {
- "type": "activate",
- "parameterValue": 0
}
], - "conditions": [
- {
- "field": "hostname",
- "key": "string",
- "value": "string"
}
], - "ID": 0
}
]
}
Create an Event Based Task
Create a new event based task.
EventBasedTasksApi.createEventBasedTask([param1, param2, ...])
EventBasedTasksApi.create_event_based_task([param1, param2, ...])
EventBasedTasksApi.createEventBasedTask([param1, param2, ...])
header Parameters
Request Body schema: application/json
The settings of the new event based task.
successful operation
Not authorized to create event based tasks.
- Payload
- Java
- Python
- JavaScript
{- "name": "string",
- "type": "computer-created-by-system",
- "enabled": true,
- "lastRunTime": 0,
- "actions": [
- {
- "type": "activate",
- "parameterValue": 0
}
], - "conditions": [
- {
- "field": "hostname",
- "key": "string",
- "value": "string"
}
]
}
- 200
{- "name": "string",
- "type": "computer-created-by-system",
- "enabled": true,
- "lastRunTime": 0,
- "actions": [
- {
- "type": "activate",
- "parameterValue": 0
}
], - "conditions": [
- {
- "field": "hostname",
- "key": "string",
- "value": "string"
}
], - "ID": 0
}
Search Event Based Tasks
Search for event based tasks using optional filters.
EventBasedTasksApi.searchEventBasedTasks([param1, param2, ...])
EventBasedTasksApi.search_event_based_tasks([param1, param2, ...])
EventBasedTasksApi.searchEventBasedTasks([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
{- "eventBasedTasks": [
- {
- "name": "string",
- "type": "computer-created-by-system",
- "enabled": true,
- "lastRunTime": 0,
- "actions": [
- {
- "type": "activate",
- "parameterValue": 0
}
], - "conditions": [
- {
- "field": "hostname",
- "key": "string",
- "value": "string"
}
], - "ID": 0
}
]
}