keyboard_arrow_down
  • 12.0
  • 20.0

Application Types

Search Application Types

post/applicationtypes/search

Search for application types using optional filters.

Related SDK Methods:
Java

ApplicationTypesApi.searchApplicationTypes([param1, param2, ...])
Python

ApplicationTypesApi.search_application_types([param1, param2, ...])
JavaScript

ApplicationTypesApi.searchApplicationTypes([param1, param2, ...])

Request
Security:
DefaultAuthentication
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

A collection of options used to filter the search results.

maxItems
integer <int32>

Limits the number of objects returned. Default 5000.

Array of objects (searchCriteria)

Array of search critiera used to filter objects. Searching with multiple criteria returns results that satisfy all of the criteria. Searching with no criteria returns all objects.

sortByObjectID
boolean

If true, forces the response objects to be sorted by ID, overriding the default sort order. Default "false".

Responses
200

successful operation

403

Not authorized to view application types.

Request samples
application/json
{
  • "maxItems": 0,
  • "searchCriteria": [
    ],
  • "sortByObjectID": true
}
Response samples
application/json
{
  • "applicationTypes": [
    ]
}

List Application Types

get/applicationtypes

Lists all application types.

Related SDK Methods:
Java

ApplicationTypesApi.listApplicationTypes([param1, param2, ...])
Python

ApplicationTypesApi.list_application_types([param1, param2, ...])
JavaScript

ApplicationTypesApi.listApplicationTypes([param1, param2, ...])

Request
Security:
DefaultAuthentication
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 application types.

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.ApplicationTypesApi;
import com.trendmicro.deepsecurity.model.ApplicationTypes;


public class ListApplicationTypesExample {
	
	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
		ApplicationTypesApi instance = new ApplicationTypesApi();
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			ApplicationTypes result = instance.listApplicationTypes(apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling ApplicationTypesApi.listApplicationTypes");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "applicationTypes": [
    ]
}

Create an Application Type

post/applicationtypes

Create a new application type.

Related SDK Methods:
Java

ApplicationTypesApi.createApplicationType([param1, param2, ...])
Python

ApplicationTypesApi.create_application_type([param1, param2, ...])
JavaScript

ApplicationTypesApi.createApplicationType([param1, param2, ...])

Request
Security:
DefaultAuthentication
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 new application type.

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 view application types.

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
}

Describe an Application Type

get/applicationtypes/{applicationTypeID}

Describe an application type by ID.

Related SDK Methods:
Java

ApplicationTypesApi.describeApplicationType([param1, param2, ...])
Python

ApplicationTypesApi.describe_application_type([param1, param2, ...])
JavaScript

ApplicationTypesApi.describeApplicationType([param1, param2, ...])

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

The ID number of the application type to describe.

Example: 1
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 application types.

404

The 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.ApplicationTypesApi;
import com.trendmicro.deepsecurity.model.ApplicationType;


public class DescribeApplicationTypeExample {
	
	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
		ApplicationTypesApi instance = new ApplicationTypesApi();
		Integer applicationTypeID = 1;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			ApplicationType result = instance.describeApplicationType(applicationTypeID, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling ApplicationTypesApi.describeApplicationType");
			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 Application Type

post/applicationtypes/{applicationTypeID}

Modify an application type by ID. Any unset elements will be left unchanged.

Related SDK Methods:
Java

ApplicationTypesApi.modifyApplicationType([param1, param2, ...])
Python

ApplicationTypesApi.modify_application_type([param1, param2, ...])
JavaScript

ApplicationTypesApi.modifyApplicationType([param1, param2, ...])

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

The ID number of the application type to modify.

Example: 1
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 application types or the requested modification is not permitted.

404

The 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
}

Delete an Application Type

delete/applicationtypes/{applicationTypeID}

Delete an application type by ID.

Related SDK Methods:
Java

ApplicationTypesApi.deleteApplicationType([param1, param2, ...])
Python

ApplicationTypesApi.delete_application_type([param1, param2, ...])
JavaScript

ApplicationTypesApi.deleteApplicationType([param1, param2, ...])

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

The ID number of the application type to delete.

Example: 1
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

Request is successful.

403

Not authorized to delete application types.

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.ApplicationTypesApi;


public class DeleteApplicationTypeExample {
	
	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
		ApplicationTypesApi instance = new ApplicationTypesApi();
		Integer applicationTypeID = 1;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			instance.deleteApplicationType(applicationTypeID, apiVersion);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling ApplicationTypesApi.deleteApplicationType");
			e.printStackTrace();
		}
	}
}
➔ Next to Intrusion Prevention Rules