Search Rulesets
Search for rulesets using optional filters.
RulesetsApi.searchRulesets([param1, param2, ...])
RulesetsApi.search_rulesets([param1, param2, ...])
RulesetsApi.searchRulesets([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 rulesets.
- 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
{- "rulesets": [
- {
- "name": "string",
- "description": "string",
- "version": 0,
- "type": "local-file",
- "created": 0,
- "lastUpdated": 0,
- "ID": 0
}
]
}
List Rulesets
Lists all rulesets.
RulesetsApi.listRulesets([param1, param2, ...])
RulesetsApi.list_rulesets([param1, param2, ...])
RulesetsApi.listRulesets([param1, param2, ...])
successful operation
Not authorized to view rulesets.
- 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.RulesetsApi; import com.trendmicro.deepsecurity.model.Rulesets; public class ListRulesetsExample { 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 RulesetsApi instance = new RulesetsApi(); String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours Rulesets result = instance.listRulesets(apiVersion); System.out.println(result); } catch (ApiException e) { System.err.println("An exception occurred when calling RulesetsApi.listRulesets"); e.printStackTrace(); } } }
- 200
{- "rulesets": [
- {
- "name": "string",
- "description": "string",
- "version": 0,
- "type": "local-file",
- "created": 0,
- "lastUpdated": 0,
- "ID": 0
}
]
}
Create a Shared Ruleset
Create a new shared ruleset.
RulesetsApi.createRuleset([param1, param2, ...])
RulesetsApi.create_ruleset([param1, param2, ...])
RulesetsApi.createRuleset([param1, param2, ...])
query Parameters
header Parameters
Request Body schema: application/json
The settings of the new ruleset.
successful operation
Not authorized to create rulesets.
- Payload
- Java
- Python
- JavaScript
{- "name": "string",
- "description": "string"
}
- 200
{- "name": "string",
- "description": "string",
- "version": 0,
- "type": "local-file",
- "created": 0,
- "lastUpdated": 0,
- "ID": 0
}
Describe a Ruleset
Describe a ruleset by ID.
RulesetsApi.describeRuleset([param1, param2, ...])
RulesetsApi.describe_ruleset([param1, param2, ...])
RulesetsApi.describeRuleset([param1, param2, ...])
successful operation
Not authorized to view rulesets.
The ruleset 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.RulesetsApi; import com.trendmicro.deepsecurity.model.Ruleset; public class DescribeRulesetExample { 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 RulesetsApi instance = new RulesetsApi(); Long rulesetID = 1L; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours Ruleset result = instance.describeRuleset(rulesetID, apiVersion); System.out.println(result); } catch (ApiException e) { System.err.println("An exception occurred when calling RulesetsApi.describeRuleset"); e.printStackTrace(); } } }
- 200
{- "name": "string",
- "description": "string",
- "version": 0,
- "type": "local-file",
- "created": 0,
- "lastUpdated": 0,
- "ID": 0
}
Delete a Ruleset
Delete a ruleset by ID.
RulesetsApi.deleteRuleset([param1, param2, ...])
RulesetsApi.delete_ruleset([param1, param2, ...])
RulesetsApi.deleteRuleset([param1, param2, ...])
Request is successful.
Request is successful.
Not authorized to delete rulesets.
- 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.RulesetsApi; public class DeleteRulesetExample { 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 RulesetsApi instance = new RulesetsApi(); Long rulesetID = 1L; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours instance.deleteRuleset(rulesetID, apiVersion); } catch (ApiException e) { System.err.println("An exception occurred when calling RulesetsApi.deleteRuleset"); e.printStackTrace(); } } }
List Ruleset Rules
List all rules of a ruleset by ID.
RulesetsApi.listRulesetRules([param1, param2, ...])
RulesetsApi.list_ruleset_rules([param1, param2, ...])
RulesetsApi.listRulesetRules([param1, param2, ...])
successful operation
Not authorized to view rulesets.
The ruleset 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.RulesetsApi; import com.trendmicro.deepsecurity.model.ApplicationControlRules; public class ListRulesetRulesExample { 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 RulesetsApi instance = new RulesetsApi(); Long rulesetID = 1L; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours ApplicationControlRules result = instance.listRulesetRules(rulesetID, apiVersion); System.out.println(result); } catch (ApiException e) { System.err.println("An exception occurred when calling RulesetsApi.listRulesetRules"); e.printStackTrace(); } } }
- 200
{- "applicationControlRules": [
- {
- "sha256": "string",
- "size": 0,
- "action": "allow",
- "path": "string",
- "fileName": "string",
- "lastUpdatedAdministrator": 0,
- "lastUpdated": 0,
- "ID": 0
}
]
}
Search Ruleset Rules
Search for ruleset rules using optional filters.
RulesetsApi.searchRulesetRules([param1, param2, ...])
RulesetsApi.search_ruleset_rules([param1, param2, ...])
RulesetsApi.searchRulesetRules([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 rulesets.
The ruleset does not exist.
- 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
{- "applicationControlRules": [
- {
- "sha256": "string",
- "size": 0,
- "action": "allow",
- "path": "string",
- "fileName": "string",
- "lastUpdatedAdministrator": 0,
- "lastUpdated": 0,
- "ID": 0
}
]
}
Describe a Ruleset Rule
Describe a ruleset rule by ID.
RulesetsApi.describeRulesetRule([param1, param2, ...])
RulesetsApi.describe_ruleset_rule([param1, param2, ...])
RulesetsApi.describeRulesetRule([param1, param2, ...])
successful operation
Not authorized to view rulesets.
The ruleset or the rule 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.RulesetsApi; import com.trendmicro.deepsecurity.model.ApplicationControlRule; public class DescribeRulesetRuleExample { 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 RulesetsApi instance = new RulesetsApi(); Long rulesetID = 1L; Long ruleID = 1L; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours ApplicationControlRule result = instance.describeRulesetRule(rulesetID, ruleID, apiVersion); System.out.println(result); } catch (ApiException e) { System.err.println("An exception occurred when calling RulesetsApi.describeRulesetRule"); e.printStackTrace(); } } }
- 200
{- "sha256": "string",
- "size": 0,
- "action": "allow",
- "path": "string",
- "fileName": "string",
- "lastUpdatedAdministrator": 0,
- "lastUpdated": 0,
- "ID": 0
}
Modify a Ruleset Rule
Modify a ruleset rule by ID.
RulesetsApi.modifyRulesetRule([param1, param2, ...])
RulesetsApi.modify_ruleset_rule([param1, param2, ...])
RulesetsApi.modifyRulesetRule([param1, param2, ...])
path Parameters
header Parameters
Request Body schema: application/json
The settings of the rule to modify.
successful operation
Not authorized to modify rulesets.
The ruleset or the rule does not exist.
- Payload
- Java
- Python
- JavaScript
{- "action": "allow"
}
- 200
{- "sha256": "string",
- "size": 0,
- "action": "allow",
- "path": "string",
- "fileName": "string",
- "lastUpdatedAdministrator": 0,
- "lastUpdated": 0,
- "ID": 0
}
Delete a Ruleset Rule
Delete a ruleset rule by ID.
RulesetsApi.deleteRulesetRule([param1, param2, ...])
RulesetsApi.delete_ruleset_rule([param1, param2, ...])
RulesetsApi.deleteRulesetRule([param1, param2, ...])
Request is successful.
Request is successful.
Not authorized to modify rulesets.
The ruleset or the rule 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.RulesetsApi; public class DeleteRulesetRuleExample { 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 RulesetsApi instance = new RulesetsApi(); Long rulesetID = 1L; Long ruleID = 1L; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours instance.deleteRulesetRule(rulesetID, ruleID, apiVersion); } catch (ApiException e) { System.err.println("An exception occurred when calling RulesetsApi.deleteRulesetRule"); e.printStackTrace(); } } }