keyboard_arrow_down
  • 12.0
  • 20.0

Policy Intrusion Prevention Application Type Details

Describe an intrusion prevention application type

get/policies/{policyID}/intrusionprevention/applicationtypes/{applicationTypeID}

Describe an intrusion prevention application type including policy-level overrides.

Related SDK Methods:
Java

PolicyIntrusionPreventionApplicationTypeDetailsApi.describeIntrusionPreventionApplicationTypeOnPolicy([param1, param2, ...])
Python

PolicyIntrusionPreventionApplicationTypeDetailsApi.describe_intrusion_prevention_application_type_on_policy([param1, param2, ...])
JavaScript

PolicyIntrusionPreventionApplicationTypeDetailsApi.describeIntrusionPreventionApplicationTypeOnPolicy([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
applicationTypeID
required
integer <int32> \d+

The ID number of the application type.

Example: 1
policyID
required
integer <int32> \d+

The ID number of the policy.

Example: 1
query Parameters
overrides
boolean

Show only overrides defined for the current policy.

header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

successful operation

403

Not authorized to view the policy.

404

The policy or application type does not exist.

Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.PolicyIntrusionPreventionApplicationTypeDetailsApi;
import com.trendmicro.deepsecurity.model.ApplicationType;


public class DescribeIntrusionPreventionApplicationTypeOnPolicyExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.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
		PolicyIntrusionPreventionApplicationTypeDetailsApi instance = new PolicyIntrusionPreventionApplicationTypeDetailsApi();
		Integer policyID = 1;
		Integer applicationTypeID = 1;
		Boolean overrides = false;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			ApplicationType result = instance.describeIntrusionPreventionApplicationTypeOnPolicy(policyID, applicationTypeID, overrides, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling PolicyIntrusionPreventionApplicationTypeDetailsApi.describeIntrusionPreventionApplicationTypeOnPolicy");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "minimumAgentVersion": "string",
  • "direction": "incoming",
  • "protocol": "icmp",
  • "portType": "any",
  • "portMultiple": [
    ],
  • "portListID": 0,
  • "recommendationsMode": "enabled",
  • "ID": 0
}

Modify an intrusion prevention application type

post/policies/{policyID}/intrusionprevention/applicationtypes/{applicationTypeID}

Modify an intrusion prevention application type assigned to a policy. Any unset elements will be left unchanged.

Related SDK Methods:
Java

PolicyIntrusionPreventionApplicationTypeDetailsApi.modifyIntrusionPreventionApplicationTypeOnPolicy([param1, param2, ...])
Python

PolicyIntrusionPreventionApplicationTypeDetailsApi.modify_intrusion_prevention_application_type_on_policy([param1, param2, ...])
JavaScript

PolicyIntrusionPreventionApplicationTypeDetailsApi.modifyIntrusionPreventionApplicationTypeOnPolicy([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
applicationTypeID
required
integer <int32> \d+

The ID number of the application type to modify.

Example: 1
policyID
required
integer <int32> \d+

The ID number of the policy.

Example: 1
query Parameters
overrides
boolean

Show only overrides defined for the current policy.

header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

The settings of the application type to modify.

description
string

Description of the ApplicationType. Searchable as String.

direction
string

Direction of the initial communication for the ApplicationType (e.g. 'outgoing' for web browsers). Searchable as Choice.

Enum: "incoming" "outgoing"
minimumAgentVersion
string

Version of the Deep Security agent or appliance required to support the ApplicationType. Searchable as String.

name
string

Display name of the ApplicationType. Searchable as String.

portListID
integer <int32>

If portType is port-list, ID of the PortList containing the port numbers the ApplicationType monitors. Set to 0 to remove any assignment. Searchable as Numeric.

portMultiple
Array of strings

If portType is multiple, the list of port numbers the ApplicationType monitors. Searchable as String.

portType
string

Port number configuration type. Searchable as Choice.

Enum: "any" "multiple" "port-list"
protocol
string

Protocol used by the ApplicationType. Searchable as Choice.

Enum: "icmp" "tcp" "udp" "tcp-udp"
recommendationsMode
string

Indicates whether recommendation scans consider the ApplicationType. Create an ApplicationType computer or policy override to modify this value. Searchable as Choice.

Enum: "enabled" "ignored" "unknown" "disabled"
Responses
200

successful operation

403

Not authorized to modify the policy or the requested modification is not permitted.

404

The policy or application type does not exist.

Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "minimumAgentVersion": "string",
  • "direction": "incoming",
  • "protocol": "icmp",
  • "portType": "any",
  • "portMultiple": [
    ],
  • "portListID": 0,
  • "recommendationsMode": "enabled"
}
Response samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "minimumAgentVersion": "string",
  • "direction": "incoming",
  • "protocol": "icmp",
  • "portType": "any",
  • "portMultiple": [
    ],
  • "portListID": 0,
  • "recommendationsMode": "enabled",
  • "ID": 0
}

Reset intrusion prevention application type overrides

delete/policies/{policyID}/intrusionprevention/applicationtypes/{applicationTypeID}

Remove all overrides for an intrusion prevention application type from a policy.

Related SDK Methods:
Java

PolicyIntrusionPreventionApplicationTypeDetailsApi.resetIntrusionPreventionApplicationTypeOnPolicy([param1, param2, ...])
Python

PolicyIntrusionPreventionApplicationTypeDetailsApi.reset_intrusion_prevention_application_type_on_policy([param1, param2, ...])
JavaScript

PolicyIntrusionPreventionApplicationTypeDetailsApi.resetIntrusionPreventionApplicationTypeOnPolicy([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
applicationTypeID
required
integer <int32> \d+

The ID number of the application type to reset.

Example: 1
policyID
required
integer <int32> \d+

The ID number of the policy.

Example: 1
query Parameters
overrides
boolean

Show only overrides defined for the current policy.

header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

successful operation

403

Not authorized to modify the policy.

404

The policy does not exist.

Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.PolicyIntrusionPreventionApplicationTypeDetailsApi;
import com.trendmicro.deepsecurity.model.ApplicationType;


public class ResetIntrusionPreventionApplicationTypeOnPolicyExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.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
		PolicyIntrusionPreventionApplicationTypeDetailsApi instance = new PolicyIntrusionPreventionApplicationTypeDetailsApi();
		Integer policyID = 1;
		Integer applicationTypeID = 1;
		Boolean overrides = false;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			ApplicationType result = instance.resetIntrusionPreventionApplicationTypeOnPolicy(policyID, applicationTypeID, overrides, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling PolicyIntrusionPreventionApplicationTypeDetailsApi.resetIntrusionPreventionApplicationTypeOnPolicy");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "minimumAgentVersion": "string",
  • "direction": "incoming",
  • "protocol": "icmp",
  • "portType": "any",
  • "portMultiple": [
    ],
  • "portListID": 0,
  • "recommendationsMode": "enabled",
  • "ID": 0
}

List intrusion prevention application types

get/policies/{policyID}/intrusionprevention/applicationtypes

Lists all intrusion prevention application types assigned to a policy.

Related SDK Methods:
Java

PolicyIntrusionPreventionApplicationTypeDetailsApi.listIntrusionPreventionApplicationTypesOnPolicy([param1, param2, ...])
Python

PolicyIntrusionPreventionApplicationTypeDetailsApi.list_intrusion_prevention_application_types_on_policy([param1, param2, ...])
JavaScript

PolicyIntrusionPreventionApplicationTypeDetailsApi.listIntrusionPreventionApplicationTypesOnPolicy([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
policyID
required
integer <int32> \d+

The ID number of the policy.

Example: 1
query Parameters
overrides
boolean

Show only application types assigned to the current policy.

header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

successful operation

403

Not authorized to view the policy.

404

The policy does not exist.

Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.PolicyIntrusionPreventionApplicationTypeDetailsApi;
import com.trendmicro.deepsecurity.model.ApplicationTypes;


public class ListIntrusionPreventionApplicationTypesOnPolicyExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.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
		PolicyIntrusionPreventionApplicationTypeDetailsApi instance = new PolicyIntrusionPreventionApplicationTypeDetailsApi();
		Integer policyID = 1;
		Boolean overrides = false;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			ApplicationTypes result = instance.listIntrusionPreventionApplicationTypesOnPolicy(policyID, overrides, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling PolicyIntrusionPreventionApplicationTypeDetailsApi.listIntrusionPreventionApplicationTypesOnPolicy");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "applicationTypes": [
    ]
}
➔ Next to Policy Intrusion Prevention Rule Details