Search Smart Folders
Search for smart folders using optional filters.
SmartFoldersApi.searchSmartFolders([param1, param2, ...])
SmartFoldersApi.search_smart_folders([param1, param2, ...])
SmartFoldersApi.searchSmartFolders([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 smart folders.
- 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
{- "smartFolders": [
- {
- "name": "string",
- "parentSmartFolderID": 0,
- "type": "standard",
- "ruleGroups": [
- {
- "rules": [
- {
- "key": "general-host-name",
- "comparisonOperator": "equals",
- "value": "string",
- "secondaryComparisonOperator": "equals",
- "secondaryValue": "string",
- "timeUnit": "minutes"
}
], - "logicalOperator": "and"
}
], - "tagFolder": {
- "cloudPlatform": "aws",
- "cloudTagOrLabelKey": "string"
}, - "logicalOperator": "and",
- "duplicateOf": 0,
- "ID": 0
}
]
}
Describe a Smart Folder
Describe a smart folder by ID.
SmartFoldersApi.describeSmartFolder([param1, param2, ...])
SmartFoldersApi.describe_smart_folder([param1, param2, ...])
SmartFoldersApi.describeSmartFolder([param1, param2, ...])
successful operation
Not authorized to view smart folders.
The smart folder does not exist.
- Java
- Python
- JavaScript
import com.trendmicro.deepsecurity.ApiException; import com.trendmicro.deepsecurity.api.SmartFoldersApi; import com.trendmicro.deepsecurity.model.SmartFolder; public class DescribeSmartFolderExample { public static void main(String[] args) { // Setup ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("YOUR HOST"); // Initialization // Set Any Required Values SmartFoldersApi instance = new SmartFoldersApi(); Long smartFolderID = 1L; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours SmartFolder result = instance.describeSmartFolder(smartFolderID, apiVersion); System.out.println(result); } catch (ApiException e) { System.err.println("An exception occurred when calling SmartFoldersApi.describeSmartFolder"); e.printStackTrace(); } } }
- 200
{- "name": "string",
- "parentSmartFolderID": 0,
- "type": "standard",
- "ruleGroups": [
- {
- "rules": [
- {
- "key": "general-host-name",
- "comparisonOperator": "equals",
- "value": "string",
- "secondaryComparisonOperator": "equals",
- "secondaryValue": "string",
- "timeUnit": "minutes"
}
], - "logicalOperator": "and"
}
], - "tagFolder": {
- "cloudPlatform": "aws",
- "cloudTagOrLabelKey": "string"
}, - "logicalOperator": "and",
- "duplicateOf": 0,
- "ID": 0
}
Modify a Smart Folder
Modify a smart folder by ID. Any unset elements will be left unchanged.
SmartFoldersApi.modifySmartFolder([param1, param2, ...])
SmartFoldersApi.modify_smart_folder([param1, param2, ...])
SmartFoldersApi.modifySmartFolder([param1, param2, ...])
path Parameters
header Parameters
Request Body schema: application/json
The settings of the smart folder to modify.
successful operation
Not authorized to modify smart folders.
The smart folder does not exist.
- Payload
- Java
- Python
- JavaScript
{- "name": "string",
- "parentSmartFolderID": 0,
- "ruleGroups": [
- {
- "rules": [
- {
- "key": "general-host-name",
- "comparisonOperator": "equals",
- "value": "string",
- "secondaryComparisonOperator": "equals",
- "secondaryValue": "string",
- "timeUnit": "minutes"
}
], - "logicalOperator": "and"
}
], - "tagFolder": {
- "cloudPlatform": "aws",
- "cloudTagOrLabelKey": "string"
}, - "logicalOperator": "and",
- "duplicateOf": 0
}
- 200
{- "name": "string",
- "parentSmartFolderID": 0,
- "type": "standard",
- "ruleGroups": [
- {
- "rules": [
- {
- "key": "general-host-name",
- "comparisonOperator": "equals",
- "value": "string",
- "secondaryComparisonOperator": "equals",
- "secondaryValue": "string",
- "timeUnit": "minutes"
}
], - "logicalOperator": "and"
}
], - "tagFolder": {
- "cloudPlatform": "aws",
- "cloudTagOrLabelKey": "string"
}, - "logicalOperator": "and",
- "duplicateOf": 0,
- "ID": 0
}
Delete a Smart Folder
Delete a smart folder by ID.
SmartFoldersApi.deleteSmartFolder([param1, param2, ...])
SmartFoldersApi.delete_smart_folder([param1, param2, ...])
SmartFoldersApi.deleteSmartFolder([param1, param2, ...])
Request is successful.
Request is successful.
Not authorized to delete smart folders.
- Java
- Python
- JavaScript
import com.trendmicro.deepsecurity.ApiException; import com.trendmicro.deepsecurity.api.SmartFoldersApi; public class DeleteSmartFolderExample { public static void main(String[] args) { // Setup ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("YOUR HOST"); // Initialization // Set Any Required Values SmartFoldersApi instance = new SmartFoldersApi(); Long smartFolderID = 1L; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours instance.deleteSmartFolder(smartFolderID, apiVersion); } catch (ApiException e) { System.err.println("An exception occurred when calling SmartFoldersApi.deleteSmartFolder"); e.printStackTrace(); } } }
List Smart Folders
Lists all smart folders.
SmartFoldersApi.listSmartFolders([param1, param2, ...])
SmartFoldersApi.list_smart_folders([param1, param2, ...])
SmartFoldersApi.listSmartFolders([param1, param2, ...])
successful operation
Not authorized to view smart folders.
- Java
- Python
- JavaScript
import com.trendmicro.deepsecurity.ApiException; import com.trendmicro.deepsecurity.api.SmartFoldersApi; import com.trendmicro.deepsecurity.model.SmartFolders; public class ListSmartFoldersExample { public static void main(String[] args) { // Setup ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("YOUR HOST"); // Initialization // Set Any Required Values SmartFoldersApi instance = new SmartFoldersApi(); String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours SmartFolders result = instance.listSmartFolders(apiVersion); System.out.println(result); } catch (ApiException e) { System.err.println("An exception occurred when calling SmartFoldersApi.listSmartFolders"); e.printStackTrace(); } } }
- 200
{- "smartFolders": [
- {
- "name": "string",
- "parentSmartFolderID": 0,
- "type": "standard",
- "ruleGroups": [
- {
- "rules": [
- {
- "key": "general-host-name",
- "comparisonOperator": "equals",
- "value": "string",
- "secondaryComparisonOperator": "equals",
- "secondaryValue": "string",
- "timeUnit": "minutes"
}
], - "logicalOperator": "and"
}
], - "tagFolder": {
- "cloudPlatform": "aws",
- "cloudTagOrLabelKey": "string"
}, - "logicalOperator": "and",
- "duplicateOf": 0,
- "ID": 0
}
]
}
Create a Smart Folder
Create a smart folder.
SmartFoldersApi.createSmartFolder([param1, param2, ...])
SmartFoldersApi.create_smart_folder([param1, param2, ...])
SmartFoldersApi.createSmartFolder([param1, param2, ...])
header Parameters
Request Body schema: application/json
The settings of the smart folder to modify.
successful operation
Not authorized to create smart folders.
- Payload
- Java
- Python
- JavaScript
{- "name": "string",
- "parentSmartFolderID": 0,
- "ruleGroups": [
- {
- "rules": [
- {
- "key": "general-host-name",
- "comparisonOperator": "equals",
- "value": "string",
- "secondaryComparisonOperator": "equals",
- "secondaryValue": "string",
- "timeUnit": "minutes"
}
], - "logicalOperator": "and"
}
], - "tagFolder": {
- "cloudPlatform": "aws",
- "cloudTagOrLabelKey": "string"
}, - "logicalOperator": "and",
- "duplicateOf": 0
}
- 200
{- "name": "string",
- "parentSmartFolderID": 0,
- "type": "standard",
- "ruleGroups": [
- {
- "rules": [
- {
- "key": "general-host-name",
- "comparisonOperator": "equals",
- "value": "string",
- "secondaryComparisonOperator": "equals",
- "secondaryValue": "string",
- "timeUnit": "minutes"
}
], - "logicalOperator": "and"
}
], - "tagFolder": {
- "cloudPlatform": "aws",
- "cloudTagOrLabelKey": "string"
}, - "logicalOperator": "and",
- "duplicateOf": 0,
- "ID": 0
}