List Schedules
Lists all schedules.
SchedulesApi.listSchedules([param1, param2, ...])
SchedulesApi.list_schedules([param1, param2, ...])
SchedulesApi.listSchedules([param1, param2, ...])
successful operation
Not authorized to view schedules.
- 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.SchedulesApi; import com.trendmicro.deepsecurity.model.Schedules; public class ListSchedulesExample { 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 SchedulesApi instance = new SchedulesApi(); String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours Schedules result = instance.listSchedules(apiVersion); System.out.println(result); } catch (ApiException e) { System.err.println("An exception occurred when calling SchedulesApi.listSchedules"); e.printStackTrace(); } } }
- 200
{- "schedules": [
- {
- "name": "string",
- "description": "string",
- "hoursOfWeek": [
- true
], - "ID": 0
}
]
}
Create a Schedule
Create a new schedule.
SchedulesApi.createSchedule([param1, param2, ...])
SchedulesApi.create_schedule([param1, param2, ...])
SchedulesApi.createSchedule([param1, param2, ...])
header Parameters
Request Body schema: application/json
The settings of the new schedule.
successful operation
Not authorized to create schedules.
- Payload
- Java
- Python
- JavaScript
{- "name": "string",
- "description": "string",
- "hoursOfWeek": [
- true
]
}
- 200
{- "name": "string",
- "description": "string",
- "hoursOfWeek": [
- true
], - "ID": 0
}
Describe a Schedule
Describe a schedule by ID.
SchedulesApi.describeSchedule([param1, param2, ...])
SchedulesApi.describe_schedule([param1, param2, ...])
SchedulesApi.describeSchedule([param1, param2, ...])
successful operation
Not authorized to view schedules.
The schedule 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.SchedulesApi; import com.trendmicro.deepsecurity.model.Schedule; public class DescribeScheduleExample { 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 SchedulesApi instance = new SchedulesApi(); Integer scheduleID = 1; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours Schedule result = instance.describeSchedule(scheduleID, apiVersion); System.out.println(result); } catch (ApiException e) { System.err.println("An exception occurred when calling SchedulesApi.describeSchedule"); e.printStackTrace(); } } }
- 200
{- "name": "string",
- "description": "string",
- "hoursOfWeek": [
- true
], - "ID": 0
}
Modify a Schedule
Modify a schedule by ID. Any unset elements will be left unchanged.
SchedulesApi.modifySchedule([param1, param2, ...])
SchedulesApi.modify_schedule([param1, param2, ...])
SchedulesApi.modifySchedule([param1, param2, ...])
path Parameters
header Parameters
Request Body schema: application/json
The settings of the request schedule to modify.
successful operation
Not authorized to modify schedules or the requested modification is not permitted.
The schedule does not exist.
- Payload
- Java
- Python
- JavaScript
{- "name": "string",
- "description": "string",
- "hoursOfWeek": [
- true
]
}
- 200
{- "name": "string",
- "description": "string",
- "hoursOfWeek": [
- true
], - "ID": 0
}
Delete a Schedule
Delete a schedule by ID.
SchedulesApi.deleteSchedule([param1, param2, ...])
SchedulesApi.delete_schedule([param1, param2, ...])
SchedulesApi.deleteSchedule([param1, param2, ...])
Request is successful.
Not authorized to delete schedules.
- 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.SchedulesApi; public class DeleteScheduleExample { 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 SchedulesApi instance = new SchedulesApi(); Integer scheduleID = 1; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours instance.deleteSchedule(scheduleID, apiVersion); } catch (ApiException e) { System.err.println("An exception occurred when calling SchedulesApi.deleteSchedule"); e.printStackTrace(); } } }
Search Schedules
Search for schedules using optional filters.
SchedulesApi.searchSchedules([param1, param2, ...])
SchedulesApi.search_schedules([param1, param2, ...])
SchedulesApi.searchSchedules([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 schedules.
- 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
{- "schedules": [
- {
- "name": "string",
- "description": "string",
- "hoursOfWeek": [
- true
], - "ID": 0
}
]
}