List Intrusion Prevention Rules
Lists all intrusion prevention rules.
IntrusionPreventionRulesApi.listIntrusionPreventionRules([param1, param2, ...])
IntrusionPreventionRulesApi.list_intrusion_prevention_rules([param1, param2, ...])
IntrusionPreventionRulesApi.listIntrusionPreventionRules([param1, param2, ...])
successful operation
Not authorized to view intrusion prevention rules.
- 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.IntrusionPreventionRulesApi; import com.trendmicro.deepsecurity.model.IntrusionPreventionRules; public class ListIntrusionPreventionRulesExample { 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 IntrusionPreventionRulesApi instance = new IntrusionPreventionRulesApi(); String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours IntrusionPreventionRules result = instance.listIntrusionPreventionRules(apiVersion); System.out.println(result); } catch (ApiException e) { System.err.println("An exception occurred when calling IntrusionPreventionRulesApi.listIntrusionPreventionRules"); e.printStackTrace(); } } }
- 200
{- "intrusionPreventionRules": [
- {
- "name": "string",
- "description": "string",
- "minimumAgentVersion": "string",
- "applicationTypeID": 0,
- "priority": "lowest",
- "ruleAvailability": "endpoint-and-workload",
- "severity": "low",
- "detectOnly": true,
- "eventLoggingDisabled": true,
- "generateEventOnPacketDrop": true,
- "alwaysIncludePacketData": true,
- "debugModeEnabled": true,
- "type": "custom",
- "originalIssue": 0,
- "lastUpdated": 0,
- "identifier": "string",
- "template": "signature",
- "signature": "string",
- "start": "string",
- "patterns": [
- "string"
], - "end": "string",
- "caseSensitive": true,
- "condition": "all",
- "action": "drop",
- "customXML": "string",
- "alertEnabled": true,
- "scheduleID": 0,
- "contextID": 0,
- "recommendationsMode": "enabled",
- "canBeAssignedAlone": true,
- "dependsOnRuleIDs": [
- 0
], - "ID": 0,
- "CVSSScore": "string",
- "CVE": [
- "string"
]
}
]
}
Create an Intrusion Prevention Rule
Create a new intrusion prevention rule.
IntrusionPreventionRulesApi.createIntrusionPreventionRule([param1, param2, ...])
IntrusionPreventionRulesApi.create_intrusion_prevention_rule([param1, param2, ...])
IntrusionPreventionRulesApi.createIntrusionPreventionRule([param1, param2, ...])
header Parameters
Request Body schema: application/json
The settings of the new intrusion prevention rule.
successful operation
Not authorized to create intrusion prevention rules.
- Payload
- Java
- Python
- JavaScript
{- "name": "string",
- "description": "string",
- "minimumAgentVersion": "string",
- "applicationTypeID": 0,
- "priority": "lowest",
- "severity": "low",
- "detectOnly": true,
- "eventLoggingDisabled": true,
- "generateEventOnPacketDrop": true,
- "alwaysIncludePacketData": true,
- "debugModeEnabled": true,
- "type": "custom",
- "originalIssue": 0,
- "lastUpdated": 0,
- "template": "signature",
- "signature": "string",
- "start": "string",
- "patterns": [
- "string"
], - "end": "string",
- "caseSensitive": true,
- "condition": "all",
- "action": "drop",
- "customXML": "string",
- "alertEnabled": true,
- "scheduleID": 0,
- "contextID": 0,
- "recommendationsMode": "enabled",
- "dependsOnRuleIDs": [
- 0
], - "CVSSScore": "string",
- "CVE": [
- "string"
]
}
- 200
{- "name": "string",
- "description": "string",
- "minimumAgentVersion": "string",
- "applicationTypeID": 0,
- "priority": "lowest",
- "ruleAvailability": "endpoint-and-workload",
- "severity": "low",
- "detectOnly": true,
- "eventLoggingDisabled": true,
- "generateEventOnPacketDrop": true,
- "alwaysIncludePacketData": true,
- "debugModeEnabled": true,
- "type": "custom",
- "originalIssue": 0,
- "lastUpdated": 0,
- "identifier": "string",
- "template": "signature",
- "signature": "string",
- "start": "string",
- "patterns": [
- "string"
], - "end": "string",
- "caseSensitive": true,
- "condition": "all",
- "action": "drop",
- "customXML": "string",
- "alertEnabled": true,
- "scheduleID": 0,
- "contextID": 0,
- "recommendationsMode": "enabled",
- "canBeAssignedAlone": true,
- "dependsOnRuleIDs": [
- 0
], - "ID": 0,
- "CVSSScore": "string",
- "CVE": [
- "string"
]
}
Search Intrusion Prevention Rules
Search for intrusion prevention rules using optional filters.
IntrusionPreventionRulesApi.searchIntrusionPreventionRules([param1, param2, ...])
IntrusionPreventionRulesApi.search_intrusion_prevention_rules([param1, param2, ...])
IntrusionPreventionRulesApi.searchIntrusionPreventionRules([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 intrusion prevention rules.
- 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
{- "intrusionPreventionRules": [
- {
- "name": "string",
- "description": "string",
- "minimumAgentVersion": "string",
- "applicationTypeID": 0,
- "priority": "lowest",
- "ruleAvailability": "endpoint-and-workload",
- "severity": "low",
- "detectOnly": true,
- "eventLoggingDisabled": true,
- "generateEventOnPacketDrop": true,
- "alwaysIncludePacketData": true,
- "debugModeEnabled": true,
- "type": "custom",
- "originalIssue": 0,
- "lastUpdated": 0,
- "identifier": "string",
- "template": "signature",
- "signature": "string",
- "start": "string",
- "patterns": [
- "string"
], - "end": "string",
- "caseSensitive": true,
- "condition": "all",
- "action": "drop",
- "customXML": "string",
- "alertEnabled": true,
- "scheduleID": 0,
- "contextID": 0,
- "recommendationsMode": "enabled",
- "canBeAssignedAlone": true,
- "dependsOnRuleIDs": [
- 0
], - "ID": 0,
- "CVSSScore": "string",
- "CVE": [
- "string"
]
}
]
}
Describe an Intrusion Prevention Rule
Describe an intrusion prevention rule by ID.
IntrusionPreventionRulesApi.describeIntrusionPreventionRule([param1, param2, ...])
IntrusionPreventionRulesApi.describe_intrusion_prevention_rule([param1, param2, ...])
IntrusionPreventionRulesApi.describeIntrusionPreventionRule([param1, param2, ...])
successful operation
Not authorized to view intrusion prevention rules.
The intrusion prevention 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.IntrusionPreventionRulesApi; import com.trendmicro.deepsecurity.model.IntrusionPreventionRule; public class DescribeIntrusionPreventionRuleExample { 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 IntrusionPreventionRulesApi instance = new IntrusionPreventionRulesApi(); Integer intrusionPreventionRuleID = 1; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours IntrusionPreventionRule result = instance.describeIntrusionPreventionRule(intrusionPreventionRuleID, apiVersion); System.out.println(result); } catch (ApiException e) { System.err.println("An exception occurred when calling IntrusionPreventionRulesApi.describeIntrusionPreventionRule"); e.printStackTrace(); } } }
- 200
{- "name": "string",
- "description": "string",
- "minimumAgentVersion": "string",
- "applicationTypeID": 0,
- "priority": "lowest",
- "ruleAvailability": "endpoint-and-workload",
- "severity": "low",
- "detectOnly": true,
- "eventLoggingDisabled": true,
- "generateEventOnPacketDrop": true,
- "alwaysIncludePacketData": true,
- "debugModeEnabled": true,
- "type": "custom",
- "originalIssue": 0,
- "lastUpdated": 0,
- "identifier": "string",
- "template": "signature",
- "signature": "string",
- "start": "string",
- "patterns": [
- "string"
], - "end": "string",
- "caseSensitive": true,
- "condition": "all",
- "action": "drop",
- "customXML": "string",
- "alertEnabled": true,
- "scheduleID": 0,
- "contextID": 0,
- "recommendationsMode": "enabled",
- "canBeAssignedAlone": true,
- "dependsOnRuleIDs": [
- 0
], - "ID": 0,
- "CVSSScore": "string",
- "CVE": [
- "string"
]
}
Modify an Intrusion Prevention Rule
Modify an intrusion prevention rule by ID. Any unset elements will be left unchanged.
IntrusionPreventionRulesApi.modifyIntrusionPreventionRule([param1, param2, ...])
IntrusionPreventionRulesApi.modify_intrusion_prevention_rule([param1, param2, ...])
IntrusionPreventionRulesApi.modifyIntrusionPreventionRule([param1, param2, ...])
path Parameters
header Parameters
Request Body schema: application/json
The settings of the intrusion prevention rules to modify.
successful operation
Not authorized to modify prevention rule or the requested modification is not permitted.
The intrusion prevention rule does not exist.
- Payload
- Java
- Python
- JavaScript
{- "name": "string",
- "description": "string",
- "minimumAgentVersion": "string",
- "applicationTypeID": 0,
- "priority": "lowest",
- "severity": "low",
- "detectOnly": true,
- "eventLoggingDisabled": true,
- "generateEventOnPacketDrop": true,
- "alwaysIncludePacketData": true,
- "debugModeEnabled": true,
- "type": "custom",
- "originalIssue": 0,
- "lastUpdated": 0,
- "template": "signature",
- "signature": "string",
- "start": "string",
- "patterns": [
- "string"
], - "end": "string",
- "caseSensitive": true,
- "condition": "all",
- "action": "drop",
- "customXML": "string",
- "alertEnabled": true,
- "scheduleID": 0,
- "contextID": 0,
- "recommendationsMode": "enabled",
- "dependsOnRuleIDs": [
- 0
], - "CVSSScore": "string",
- "CVE": [
- "string"
]
}
- 200
{- "name": "string",
- "description": "string",
- "minimumAgentVersion": "string",
- "applicationTypeID": 0,
- "priority": "lowest",
- "ruleAvailability": "endpoint-and-workload",
- "severity": "low",
- "detectOnly": true,
- "eventLoggingDisabled": true,
- "generateEventOnPacketDrop": true,
- "alwaysIncludePacketData": true,
- "debugModeEnabled": true,
- "type": "custom",
- "originalIssue": 0,
- "lastUpdated": 0,
- "identifier": "string",
- "template": "signature",
- "signature": "string",
- "start": "string",
- "patterns": [
- "string"
], - "end": "string",
- "caseSensitive": true,
- "condition": "all",
- "action": "drop",
- "customXML": "string",
- "alertEnabled": true,
- "scheduleID": 0,
- "contextID": 0,
- "recommendationsMode": "enabled",
- "canBeAssignedAlone": true,
- "dependsOnRuleIDs": [
- 0
], - "ID": 0,
- "CVSSScore": "string",
- "CVE": [
- "string"
]
}
Delete an Intrusion Prevention Rule
Delete an intrusion prevention rule by ID.
IntrusionPreventionRulesApi.deleteIntrusionPreventionRule([param1, param2, ...])
IntrusionPreventionRulesApi.delete_intrusion_prevention_rule([param1, param2, ...])
IntrusionPreventionRulesApi.deleteIntrusionPreventionRule([param1, param2, ...])
Request is successful.
Not authorized to delete intrusion prevention rules.
- 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.IntrusionPreventionRulesApi; public class DeleteIntrusionPreventionRuleExample { 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 IntrusionPreventionRulesApi instance = new IntrusionPreventionRulesApi(); Integer intrusionPreventionRuleID = 1; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours instance.deleteIntrusionPreventionRule(intrusionPreventionRuleID, apiVersion); } catch (ApiException e) { System.err.println("An exception occurred when calling IntrusionPreventionRulesApi.deleteIntrusionPreventionRule"); e.printStackTrace(); } } }