List Stateful Configurations
Lists all stateful configurations.
StatefulConfigurationsApi.listStatefulConfigurations([param1, param2, ...])
StatefulConfigurationsApi.list_stateful_configurations([param1, param2, ...])
StatefulConfigurationsApi.listStatefulConfigurations([param1, param2, ...])
successful operation
Not authorized to view stateful configurations.
- 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.StatefulConfigurationsApi; import com.trendmicro.deepsecurity.model.StatefulConfigurations; public class ListStatefulConfigurationsExample { 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 StatefulConfigurationsApi instance = new StatefulConfigurationsApi(); String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours StatefulConfigurations result = instance.listStatefulConfigurations(apiVersion); System.out.println(result); } catch (ApiException e) { System.err.println("An exception occurred when calling StatefulConfigurationsApi.listStatefulConfigurations"); e.printStackTrace(); } } }
- 200
{- "statefulConfigurations": [
- {
- "name": "string",
- "description": "string",
- "denyFragmentedPacketsEnabled": true,
- "denyPacketsContainingCwrOrEceEnabled": true,
- "maxIncomingConnections": 0,
- "maxOutgoingConnections": 0,
- "maxHalfOpenConnections": 0,
- "tcpstatefulInspectionEnabled": true,
- "tcpstatefulLoggingEnabled": true,
- "udpstatefulInspectionEnabled": true,
- "udpstatefulLoggingEnabled": true,
- "icmpstatefulInspectionEnabled": true,
- "icmpstatefulLoggingEnabled": true,
- "ID": 0
}
]
}
Create a Stateful Configuration
Create a new stateful configuration.
StatefulConfigurationsApi.createStatefulConfiguration([param1, param2, ...])
StatefulConfigurationsApi.create_stateful_configuration([param1, param2, ...])
StatefulConfigurationsApi.createStatefulConfiguration([param1, param2, ...])
header Parameters
Request Body schema: application/json
The settings of the new stateful configuration.
successful operation
Not authorized to create stateful configurations.
- Payload
- Java
- Python
- JavaScript
{- "name": "string",
- "description": "string",
- "denyFragmentedPacketsEnabled": true,
- "denyPacketsContainingCwrOrEceEnabled": true,
- "maxIncomingConnections": 0,
- "maxOutgoingConnections": 0,
- "maxHalfOpenConnections": 0,
- "tcpstatefulInspectionEnabled": true,
- "tcpstatefulLoggingEnabled": true,
- "udpstatefulInspectionEnabled": true,
- "udpstatefulLoggingEnabled": true,
- "icmpstatefulInspectionEnabled": true,
- "icmpstatefulLoggingEnabled": true
}
- 200
{- "name": "string",
- "description": "string",
- "denyFragmentedPacketsEnabled": true,
- "denyPacketsContainingCwrOrEceEnabled": true,
- "maxIncomingConnections": 0,
- "maxOutgoingConnections": 0,
- "maxHalfOpenConnections": 0,
- "tcpstatefulInspectionEnabled": true,
- "tcpstatefulLoggingEnabled": true,
- "udpstatefulInspectionEnabled": true,
- "udpstatefulLoggingEnabled": true,
- "icmpstatefulInspectionEnabled": true,
- "icmpstatefulLoggingEnabled": true,
- "ID": 0
}
Search Stateful Configurations
Search for stateful configurations using optional filters.
StatefulConfigurationsApi.searchStatefulConfigurations([param1, param2, ...])
StatefulConfigurationsApi.search_stateful_configurations([param1, param2, ...])
StatefulConfigurationsApi.searchStatefulConfigurations([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 stateful configurations.
- 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
{- "statefulConfigurations": [
- {
- "name": "string",
- "description": "string",
- "denyFragmentedPacketsEnabled": true,
- "denyPacketsContainingCwrOrEceEnabled": true,
- "maxIncomingConnections": 0,
- "maxOutgoingConnections": 0,
- "maxHalfOpenConnections": 0,
- "tcpstatefulInspectionEnabled": true,
- "tcpstatefulLoggingEnabled": true,
- "udpstatefulInspectionEnabled": true,
- "udpstatefulLoggingEnabled": true,
- "icmpstatefulInspectionEnabled": true,
- "icmpstatefulLoggingEnabled": true,
- "ID": 0
}
]
}
Describe a Stateful Configuration
Describe a stateful configuration by ID.
StatefulConfigurationsApi.describeStatefulConfiguration([param1, param2, ...])
StatefulConfigurationsApi.describe_stateful_configuration([param1, param2, ...])
StatefulConfigurationsApi.describeStatefulConfiguration([param1, param2, ...])
successful operation
Not authorized to view stateful configurations.
The stateful configuration 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.StatefulConfigurationsApi; import com.trendmicro.deepsecurity.model.StatefulConfiguration; public class DescribeStatefulConfigurationExample { 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 StatefulConfigurationsApi instance = new StatefulConfigurationsApi(); Integer statefulConfigurationID = 1; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours StatefulConfiguration result = instance.describeStatefulConfiguration(statefulConfigurationID, apiVersion); System.out.println(result); } catch (ApiException e) { System.err.println("An exception occurred when calling StatefulConfigurationsApi.describeStatefulConfiguration"); e.printStackTrace(); } } }
- 200
{- "name": "string",
- "description": "string",
- "denyFragmentedPacketsEnabled": true,
- "denyPacketsContainingCwrOrEceEnabled": true,
- "maxIncomingConnections": 0,
- "maxOutgoingConnections": 0,
- "maxHalfOpenConnections": 0,
- "tcpstatefulInspectionEnabled": true,
- "tcpstatefulLoggingEnabled": true,
- "udpstatefulInspectionEnabled": true,
- "udpstatefulLoggingEnabled": true,
- "icmpstatefulInspectionEnabled": true,
- "icmpstatefulLoggingEnabled": true,
- "ID": 0
}
Modify a Stateful Configuration
Modify a stateful configuration by ID. Any unset elements will be left unchanged.
StatefulConfigurationsApi.modifyStatefulConfiguration([param1, param2, ...])
StatefulConfigurationsApi.modify_stateful_configuration([param1, param2, ...])
StatefulConfigurationsApi.modifyStatefulConfiguration([param1, param2, ...])
path Parameters
header Parameters
Request Body schema: application/json
The settings of the stateful configuration to modify.
successful operation
Not authorized to modify stateful configurations or the requested modification is not permitted.
The stateful configuration does not exist.
- Payload
- Java
- Python
- JavaScript
{- "name": "string",
- "description": "string",
- "denyFragmentedPacketsEnabled": true,
- "denyPacketsContainingCwrOrEceEnabled": true,
- "maxIncomingConnections": 0,
- "maxOutgoingConnections": 0,
- "maxHalfOpenConnections": 0,
- "tcpstatefulInspectionEnabled": true,
- "tcpstatefulLoggingEnabled": true,
- "udpstatefulInspectionEnabled": true,
- "udpstatefulLoggingEnabled": true,
- "icmpstatefulInspectionEnabled": true,
- "icmpstatefulLoggingEnabled": true
}
- 200
{- "name": "string",
- "description": "string",
- "denyFragmentedPacketsEnabled": true,
- "denyPacketsContainingCwrOrEceEnabled": true,
- "maxIncomingConnections": 0,
- "maxOutgoingConnections": 0,
- "maxHalfOpenConnections": 0,
- "tcpstatefulInspectionEnabled": true,
- "tcpstatefulLoggingEnabled": true,
- "udpstatefulInspectionEnabled": true,
- "udpstatefulLoggingEnabled": true,
- "icmpstatefulInspectionEnabled": true,
- "icmpstatefulLoggingEnabled": true,
- "ID": 0
}
Delete a Stateful Configuration
Delete a stateful configuration by ID.
StatefulConfigurationsApi.deleteStatefulConfiguration([param1, param2, ...])
StatefulConfigurationsApi.delete_stateful_configuration([param1, param2, ...])
StatefulConfigurationsApi.deleteStatefulConfiguration([param1, param2, ...])
Request is successful.
Not authorized to delete stateful configurations.
- 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.StatefulConfigurationsApi; public class DeleteStatefulConfigurationExample { 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 StatefulConfigurationsApi instance = new StatefulConfigurationsApi(); Integer statefulConfigurationID = 1; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours instance.deleteStatefulConfiguration(statefulConfigurationID, apiVersion); } catch (ApiException e) { System.err.println("An exception occurred when calling StatefulConfigurationsApi.deleteStatefulConfiguration"); e.printStackTrace(); } } }