keyboard_arrow_down
  • 12.0
  • 20.0

Stateful Configurations

Search Stateful Configurations

post/statefulconfigurations/search

Search for stateful configurations using optional filters.

Related SDK Methods:
Java

StatefulConfigurationsApi.searchStatefulConfigurations([param1, param2, ...])
Python

StatefulConfigurationsApi.search_stateful_configurations([param1, param2, ...])
JavaScript

StatefulConfigurationsApi.searchStatefulConfigurations([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 stateful configurations.

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

List Stateful Configurations

get/statefulconfigurations

Lists all stateful configurations.

Related SDK Methods:
Java

StatefulConfigurationsApi.listStatefulConfigurations([param1, param2, ...])
Python

StatefulConfigurationsApi.list_stateful_configurations([param1, param2, ...])
JavaScript

StatefulConfigurationsApi.listStatefulConfigurations([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 stateful configurations.

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.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 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
		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();
		}
	}
}
Response samples
application/json
{
  • "statefulConfigurations": [
    ]
}

Create a Stateful Configuration

post/statefulconfigurations

Create a new stateful configuration.

Related SDK Methods:
Java

StatefulConfigurationsApi.createStatefulConfiguration([param1, param2, ...])
Python

StatefulConfigurationsApi.create_stateful_configuration([param1, param2, ...])
JavaScript

StatefulConfigurationsApi.createStatefulConfiguration([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 stateful configuration.

denyFragmentedPacketsEnabled
boolean

Controls if fragmented packets are denied. Set to true to deny fragmented packets. Searchable as Boolean.

denyPacketsContainingCwrOrEceEnabled
boolean

Controls if TCP CWR, ECE flags are denied. Set to true to enable CWR or ECE flags. Searchable as Boolean.

description
string

Description of the stateful configuration. Searchable as String.

icmpstatefulInspectionEnabled
boolean
icmpstatefulLoggingEnabled
boolean
maxHalfOpenConnections
integer <int32>

Maximum allowed half open connections. Searchable as Numeric.

maxIncomingConnections
integer <int32>

Maximum allowed incoming connections. Searchable as Numeric.

maxOutgoingConnections
integer <int32>

Maximum allowed outgoing connections. Searchable as Numeric.

name
string

Name of the stateful configuration. Searchable as String.

tcpstatefulInspectionEnabled
boolean
tcpstatefulLoggingEnabled
boolean
udpstatefulInspectionEnabled
boolean
udpstatefulLoggingEnabled
boolean
Responses
200

successful operation

403

Not authorized to create stateful configurations.

Request samples
application/json
{
  • "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
}
Response samples
application/json
{
  • "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

get/statefulconfigurations/{statefulConfigurationID}

Describe a stateful configuration by ID.

Related SDK Methods:
Java

StatefulConfigurationsApi.describeStatefulConfiguration([param1, param2, ...])
Python

StatefulConfigurationsApi.describe_stateful_configuration([param1, param2, ...])
JavaScript

StatefulConfigurationsApi.describeStatefulConfiguration([param1, param2, ...])

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

The ID number of the stateful configuration 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 stateful configurations.

404

The stateful configuration 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.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 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
		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();
		}
	}
}
Response samples
application/json
{
  • "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

post/statefulconfigurations/{statefulConfigurationID}

Modify a stateful configuration by ID. Any unset elements will be left unchanged.

Related SDK Methods:
Java

StatefulConfigurationsApi.modifyStatefulConfiguration([param1, param2, ...])
Python

StatefulConfigurationsApi.modify_stateful_configuration([param1, param2, ...])
JavaScript

StatefulConfigurationsApi.modifyStatefulConfiguration([param1, param2, ...])

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

The ID number of the stateful configuration 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 stateful configuration to modify.

denyFragmentedPacketsEnabled
boolean

Controls if fragmented packets are denied. Set to true to deny fragmented packets. Searchable as Boolean.

denyPacketsContainingCwrOrEceEnabled
boolean

Controls if TCP CWR, ECE flags are denied. Set to true to enable CWR or ECE flags. Searchable as Boolean.

description
string

Description of the stateful configuration. Searchable as String.

icmpstatefulInspectionEnabled
boolean
icmpstatefulLoggingEnabled
boolean
maxHalfOpenConnections
integer <int32>

Maximum allowed half open connections. Searchable as Numeric.

maxIncomingConnections
integer <int32>

Maximum allowed incoming connections. Searchable as Numeric.

maxOutgoingConnections
integer <int32>

Maximum allowed outgoing connections. Searchable as Numeric.

name
string

Name of the stateful configuration. Searchable as String.

tcpstatefulInspectionEnabled
boolean
tcpstatefulLoggingEnabled
boolean
udpstatefulInspectionEnabled
boolean
udpstatefulLoggingEnabled
boolean
Responses
200

successful operation

403

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

404

The stateful configuration does not exist.

Request samples
application/json
{
  • "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
}
Response samples
application/json
{
  • "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/statefulconfigurations/{statefulConfigurationID}

Delete a stateful configuration by ID.

Related SDK Methods:
Java

StatefulConfigurationsApi.deleteStatefulConfiguration([param1, param2, ...])
Python

StatefulConfigurationsApi.delete_stateful_configuration([param1, param2, ...])
JavaScript

StatefulConfigurationsApi.deleteStatefulConfiguration([param1, param2, ...])

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

The ID number of the stateful configuration 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 stateful configurations.

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


public class DeleteStatefulConfigurationExample {
	
	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
		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();
		}
	}
}
➔ Next to Integrity Monitoring Rules