List Interface Types
Lists all interface types.
InterfaceTypesApi.listInterfaceTypes([param1, param2, ...])
InterfaceTypesApi.list_interface_types([param1, param2, ...])
InterfaceTypesApi.listInterfaceTypes([param1, param2, ...])
successful operation
Not authorized to view interface types.
The policy 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.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 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 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(); } } }
- 200
{- "interfaceTypes": [
- {
- "name": "string",
- "description": "string",
- "matches": [
- "string"
], - "ID": 0
}
]
}
Create an Interface Type
Create a new interface type.
InterfaceTypesApi.createInterfaceType([param1, param2, ...])
InterfaceTypesApi.create_interface_type([param1, param2, ...])
InterfaceTypesApi.createInterfaceType([param1, param2, ...])
header Parameters
Request Body schema: application/json
The settings of the new interface type.
successful operation
Not authorized to create interface types.
The policy does not exist.
- Payload
- Java
- Python
- JavaScript
{- "name": "string",
- "description": "string",
- "matches": [
- "string"
]
}
- 200
{- "name": "string",
- "description": "string",
- "matches": [
- "string"
], - "ID": 0
}
Search Interface Types
Search for interface types using optional filters.
InterfaceTypesApi.searchInterfaceTypes([param1, param2, ...])
InterfaceTypesApi.search_interface_types([param1, param2, ...])
InterfaceTypesApi.searchInterfaceTypes([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 interface types.
The policy 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,
- "idValueList": [
- 0
], - "idTest": "less-than"
}
], - "sortByObjectID": true
}
- 200
{- "interfaceTypes": [
- {
- "name": "string",
- "description": "string",
- "matches": [
- "string"
], - "ID": 0
}
]
}
Describe an Interface Type
Describe an interface type by ID.
InterfaceTypesApi.describeInterfaceType([param1, param2, ...])
InterfaceTypesApi.describe_interface_type([param1, param2, ...])
InterfaceTypesApi.describeInterfaceType([param1, param2, ...])
successful operation
Not authorized to view interface types.
The interface type or policy 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.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 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 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(); } } }
- 200
{- "name": "string",
- "description": "string",
- "matches": [
- "string"
], - "ID": 0
}
Modify an Interface Type
Modify an interface type by ID. Any unset elements will be left unchanged.
InterfaceTypesApi.modifyInterfaceType([param1, param2, ...])
InterfaceTypesApi.modify_interface_type([param1, param2, ...])
InterfaceTypesApi.modifyInterfaceType([param1, param2, ...])
path Parameters
header Parameters
Request Body schema: application/json
The settings of the interface type to modify.
successful operation
Not authorized to modify interface types or the requested modification is not permitted.
The interface type or policy does not exist.
- Payload
- Java
- Python
- JavaScript
{- "name": "string",
- "description": "string",
- "matches": [
- "string"
]
}
- 200
{- "name": "string",
- "description": "string",
- "matches": [
- "string"
], - "ID": 0
}
Delete an Interface Type
Delete an interface type by ID.
InterfaceTypesApi.deleteInterfaceType([param1, param2, ...])
InterfaceTypesApi.delete_interface_type([param1, param2, ...])
InterfaceTypesApi.deleteInterfaceType([param1, param2, ...])
Request is successful.
Not authorized to delete interface types.
The interface type or policy 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.InterfaceTypesApi; public class DeleteInterfaceTypeExample { 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 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(); } } }