Interface Types

Search Interface Types

post/policies/{policyID}/interfacetypes/search

Search for interface types using optional filters.

Related SDK Methods:

Java

InterfaceTypesApi.searchInterfaceTypes([param1, param2, ...])

Python

InterfaceTypesApi.search_interface_types([param1, param2, ...])

JavaScript

InterfaceTypesApi.searchInterfaceTypes([param1, param2, ...])

Request

Security:

DefaultAuthentication

path Parameters

policyID

required

integer <int32> \d+

The ID number of the policy.

Example: 1

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 interface types.

404

The policy does not exist.

Request samples

Payload
Java
Python
JavaScript

application/json

{"maxItems": 0,
"searchCriteria": [{"fieldName": "string",
"booleanTest": true,
"numericTest": "less-than",
"numericValue": 0,
"stringTest": "equal",
"stringValue": "string",
"stringWildcards": true,
"choiceTest": "equal",
"choiceValue": "string",
"firstDateValue": 0,
"firstDateInclusive": true,
"lastDateValue": 0,
"lastDateInclusive": true,
"nullTest": true,
"idValue": 0,
"idTest": "less-than"
}
],
"sortByObjectID": true
}

Response samples

application/json

{"interfaceTypes": [{"name": "string",
"description": "string",
"matches": ["string"
],
"ID": 0
}
]
}

List Interface Types

get/policies/{policyID}/interfacetypes

Lists all interface types.

Related SDK Methods:

Java

InterfaceTypesApi.listInterfaceTypes([param1, param2, ...])

Python

InterfaceTypesApi.list_interface_types([param1, param2, ...])

JavaScript

InterfaceTypesApi.listInterfaceTypes([param1, param2, ...])

Request

Security:

DefaultAuthentication

path Parameters

policyID

required

integer <int32> \d+

The ID number of the policy.

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 interface types.

404

The policy does not exist.

Request samples

Java
Python
JavaScript

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.InterfaceTypesApi;
import com.trendmicro.deepsecurity.model.InterfaceTypes;


public class ListInterfaceTypesExample {
	
	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
		InterfaceTypesApi instance = new InterfaceTypesApi();
		Integer policyID = 1;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			InterfaceTypes result = instance.listInterfaceTypes(policyID, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling InterfaceTypesApi.listInterfaceTypes");
			e.printStackTrace();
		}
	}
}

Response samples

application/json

{"interfaceTypes": [{"name": "string",
"description": "string",
"matches": ["string"
],
"ID": 0
}
]
}

Create an Interface Type

post/policies/{policyID}/interfacetypes

Create a new interface type.

Related SDK Methods:

Java

InterfaceTypesApi.createInterfaceType([param1, param2, ...])

Python

InterfaceTypesApi.create_interface_type([param1, param2, ...])

JavaScript

InterfaceTypesApi.createInterfaceType([param1, param2, ...])

Request

Security:

DefaultAuthentication

path Parameters

policyID

required

integer <int32> \d+

The ID number of the policy.

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 new interface type.

description	string Description of the InterfaceType. Searchable as String.
matches	Array of strings String patterns to match with Interface names and display names. One pattern per line. The `*` character can be used for wildcard matches. Searchable as String.
name	string Name of the InterfaceType. Searchable as String.

Responses

200

successful operation

403

Not authorized to create interface types.

404

The policy does not exist.

Request samples

Payload
Java
Python
JavaScript

application/json

{"name": "string",
"description": "string",
"matches": ["string"
]
}

Response samples

application/json

{"name": "string",
"description": "string",
"matches": ["string"
],
"ID": 0
}

Describe an Interface Type

get/policies/{policyID}/interfacetypes/{interfaceTypeID}

Describe an interface type by ID.

Related SDK Methods:

Java

InterfaceTypesApi.describeInterfaceType([param1, param2, ...])

Python

InterfaceTypesApi.describe_interface_type([param1, param2, ...])

JavaScript

InterfaceTypesApi.describeInterfaceType([param1, param2, ...])

Request

Security:

DefaultAuthentication

path Parameters

interfaceTypeID required	integer <int32> \d+ The ID number of the interface type to describe. Example: 1
policyID required	integer <int32> \d+ The ID number of the policy. 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 interface types.

404

The interface type or policy does not exist.

Request samples

Java
Python
JavaScript

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.InterfaceTypesApi;
import com.trendmicro.deepsecurity.model.InterfaceType;


public class DescribeInterfaceTypeExample {
	
	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
		InterfaceTypesApi instance = new InterfaceTypesApi();
		Integer policyID = 1;
		Integer interfaceTypeID = 1;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			InterfaceType result = instance.describeInterfaceType(policyID, interfaceTypeID, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling InterfaceTypesApi.describeInterfaceType");
			e.printStackTrace();
		}
	}
}

Response samples

application/json

{"name": "string",
"description": "string",
"matches": ["string"
],
"ID": 0
}

Modify an Interface Type

post/policies/{policyID}/interfacetypes/{interfaceTypeID}

Modify an interface type by ID.

Related SDK Methods:

Java

InterfaceTypesApi.modifyInterfaceType([param1, param2, ...])

Python

InterfaceTypesApi.modify_interface_type([param1, param2, ...])

JavaScript

InterfaceTypesApi.modifyInterfaceType([param1, param2, ...])

Request

Security:

DefaultAuthentication

path Parameters

interfaceTypeID required	integer <int32> \d+ The ID number of the interface type to modify. Example: 1
policyID required	integer <int32> \d+ The ID number of the policy. 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 interface type to modify.

description	string Description of the InterfaceType. Searchable as String.
matches	Array of strings String patterns to match with Interface names and display names. One pattern per line. The `*` character can be used for wildcard matches. Searchable as String.
name	string Name of the InterfaceType. Searchable as String.

Responses

200

successful operation

403

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

404

The interface type or policy does not exist.

Request samples

Payload
Java
Python
JavaScript

application/json

{"name": "string",
"description": "string",
"matches": ["string"
]
}

Response samples

application/json

{"name": "string",
"description": "string",
"matches": ["string"
],
"ID": 0
}

Delete an Interface Type

delete/policies/{policyID}/interfacetypes/{interfaceTypeID}

Delete an interface type by ID.

Related SDK Methods:

Java

InterfaceTypesApi.deleteInterfaceType([param1, param2, ...])

Python

InterfaceTypesApi.delete_interface_type([param1, param2, ...])

JavaScript

InterfaceTypesApi.deleteInterfaceType([param1, param2, ...])

Request

Security:

DefaultAuthentication

path Parameters

interfaceTypeID required	integer <int32> \d+ The ID number of the interface type to delete. Example: 1
policyID required	integer <int32> \d+ The ID number of the policy. 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 interface types.

404

The interface type or policy does not exist.

Request samples

Java
Python
JavaScript

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


public class DeleteInterfaceTypeExample {
	
	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
		InterfaceTypesApi instance = new InterfaceTypesApi();
		Integer policyID = 1;
		Integer interfaceTypeID = 1;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			instance.deleteInterfaceType(policyID, interfaceTypeID, apiVersion);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling InterfaceTypesApi.deleteInterfaceType");
			e.printStackTrace();
		}
	}
}

➔ Next to IP Lists