Smart Folders

List Smart Folders

get/smartfolders

Lists all smart folders.

Related SDK Methods:

Java

SmartFoldersApi.listSmartFolders([param1, param2, ...])

Python

SmartFoldersApi.list_smart_folders([param1, param2, ...])

JavaScript

SmartFoldersApi.listSmartFolders([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 smart folders.

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.SmartFoldersApi;
import com.trendmicro.deepsecurity.model.SmartFolders;


public class ListSmartFoldersExample {
	
	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
		SmartFoldersApi instance = new SmartFoldersApi();
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			SmartFolders result = instance.listSmartFolders(apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling SmartFoldersApi.listSmartFolders");
			e.printStackTrace();
		}
	}
}

Response samples

application/json

{"smartFolders": [{"name": "string",
"parentSmartFolderID": 0,
"type": "standard",
"ruleGroups": [{"rules": [{"key": "general-host-name",
"comparisonOperator": "equals",
"value": "string",
"secondaryComparisonOperator": "equals",
"secondaryValue": "string",
"timeUnit": "minutes"
}
],
"logicalOperator": "and"
}
],
"tagFolder": {"cloudPlatform": "aws",
"cloudTagOrLabelKey": "string"
},
"logicalOperator": "and",
"duplicateOf": 0,
"ID": 0
}
]
}

Create a Smart Folder

post/smartfolders

Create a smart folder.

Related SDK Methods:

Java

SmartFoldersApi.createSmartFolder([param1, param2, ...])

Python

SmartFoldersApi.create_smart_folder([param1, param2, ...])

JavaScript

SmartFoldersApi.createSmartFolder([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 smart folder to modify.

duplicateOf	integer <int64> The ID of the Smart Folder to duplicate. If this value is set, then all other parameters will be ignored.
logicalOperator	string Comparison of the smart folder. Enum: "and" "or"
name required	string Name of the smart folder. The maximum length is 255 characters. Searchable as String.
parentSmartFolderID	integer <int64> ID of the parent smart folder. Searchable as Numeric.
	Array of objects (smartFolderRuleGroup) Rule groups of the smart folder.
	object (tagFolder) Details of a tag folder for AWS/GCP/Azure.

Responses

200

successful operation

403

Not authorized to create smart folders.

Request samples

Payload
Java
Python
JavaScript

application/json

{"name": "string",
"parentSmartFolderID": 0,
"ruleGroups": [{"rules": [{"key": "general-host-name",
"comparisonOperator": "equals",
"value": "string",
"secondaryComparisonOperator": "equals",
"secondaryValue": "string",
"timeUnit": "minutes"
}
],
"logicalOperator": "and"
}
],
"tagFolder": {"cloudPlatform": "aws",
"cloudTagOrLabelKey": "string"
},
"logicalOperator": "and",
"duplicateOf": 0
}

Response samples

application/json

{"name": "string",
"parentSmartFolderID": 0,
"type": "standard",
"ruleGroups": [{"rules": [{"key": "general-host-name",
"comparisonOperator": "equals",
"value": "string",
"secondaryComparisonOperator": "equals",
"secondaryValue": "string",
"timeUnit": "minutes"
}
],
"logicalOperator": "and"
}
],
"tagFolder": {"cloudPlatform": "aws",
"cloudTagOrLabelKey": "string"
},
"logicalOperator": "and",
"duplicateOf": 0,
"ID": 0
}

Describe a Smart Folder

get/smartfolders/{smartFolderID}

Describe a smart folder by ID.

Related SDK Methods:

Java

SmartFoldersApi.describeSmartFolder([param1, param2, ...])

Python

SmartFoldersApi.describe_smart_folder([param1, param2, ...])

JavaScript

SmartFoldersApi.describeSmartFolder([param1, param2, ...])

Request

Security:

DefaultAuthentication

path Parameters

smartFolderID

required

integer <int64> \d+

The ID number of the smart folder 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 smart folders.

404

The smart folder 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.SmartFoldersApi;
import com.trendmicro.deepsecurity.model.SmartFolder;


public class DescribeSmartFolderExample {
	
	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
		SmartFoldersApi instance = new SmartFoldersApi();
		Long smartFolderID = 1L;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			SmartFolder result = instance.describeSmartFolder(smartFolderID, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling SmartFoldersApi.describeSmartFolder");
			e.printStackTrace();
		}
	}
}

Response samples

application/json

{"name": "string",
"parentSmartFolderID": 0,
"type": "standard",
"ruleGroups": [{"rules": [{"key": "general-host-name",
"comparisonOperator": "equals",
"value": "string",
"secondaryComparisonOperator": "equals",
"secondaryValue": "string",
"timeUnit": "minutes"
}
],
"logicalOperator": "and"
}
],
"tagFolder": {"cloudPlatform": "aws",
"cloudTagOrLabelKey": "string"
},
"logicalOperator": "and",
"duplicateOf": 0,
"ID": 0
}

Modify a Smart Folder

post/smartfolders/{smartFolderID}

Modify a smart folder by ID. Any unset elements will be left unchanged.

Related SDK Methods:

Java

SmartFoldersApi.modifySmartFolder([param1, param2, ...])

Python

SmartFoldersApi.modify_smart_folder([param1, param2, ...])

JavaScript

SmartFoldersApi.modifySmartFolder([param1, param2, ...])

Request

Security:

DefaultAuthentication

path Parameters

smartFolderID

required

integer <int64> \d+

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

duplicateOf	integer <int64> The ID of the Smart Folder to duplicate. If this value is set, then all other parameters will be ignored.
logicalOperator	string Comparison of the smart folder. Enum: "and" "or"
name required	string Name of the smart folder. The maximum length is 255 characters. Searchable as String.
parentSmartFolderID	integer <int64> ID of the parent smart folder. Searchable as Numeric.
	Array of objects (smartFolderRuleGroup) Rule groups of the smart folder.
	object (tagFolder) Details of a tag folder for AWS/GCP/Azure.

Responses

200

successful operation

403

Not authorized to modify smart folders.

404

The smart folder does not exist.

Request samples

Payload
Java
Python
JavaScript

application/json

{"name": "string",
"parentSmartFolderID": 0,
"ruleGroups": [{"rules": [{"key": "general-host-name",
"comparisonOperator": "equals",
"value": "string",
"secondaryComparisonOperator": "equals",
"secondaryValue": "string",
"timeUnit": "minutes"
}
],
"logicalOperator": "and"
}
],
"tagFolder": {"cloudPlatform": "aws",
"cloudTagOrLabelKey": "string"
},
"logicalOperator": "and",
"duplicateOf": 0
}

Response samples

application/json

{"name": "string",
"parentSmartFolderID": 0,
"type": "standard",
"ruleGroups": [{"rules": [{"key": "general-host-name",
"comparisonOperator": "equals",
"value": "string",
"secondaryComparisonOperator": "equals",
"secondaryValue": "string",
"timeUnit": "minutes"
}
],
"logicalOperator": "and"
}
],
"tagFolder": {"cloudPlatform": "aws",
"cloudTagOrLabelKey": "string"
},
"logicalOperator": "and",
"duplicateOf": 0,
"ID": 0
}

Delete a Smart Folder

delete/smartfolders/{smartFolderID}

Delete a smart folder by ID.

Related SDK Methods:

Java

SmartFoldersApi.deleteSmartFolder([param1, param2, ...])

Python

SmartFoldersApi.delete_smart_folder([param1, param2, ...])

JavaScript

SmartFoldersApi.deleteSmartFolder([param1, param2, ...])

Request

Security:

DefaultAuthentication

path Parameters

smartFolderID

required

integer <int64> \d+

The ID number of the smart folder 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.

204

Request is successful.

403

Not authorized to delete smart folders.

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


public class DeleteSmartFolderExample {
	
	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
		SmartFoldersApi instance = new SmartFoldersApi();
		Long smartFolderID = 1L;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			instance.deleteSmartFolder(smartFolderID, apiVersion);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling SmartFoldersApi.deleteSmartFolder");
			e.printStackTrace();
		}
	}
}

Search Smart Folders

post/smartfolders/search

Search for smart folders using optional filters.

Related SDK Methods:

Java

SmartFoldersApi.searchSmartFolders([param1, param2, ...])

Python

SmartFoldersApi.search_smart_folders([param1, param2, ...])

JavaScript

SmartFoldersApi.searchSmartFolders([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 smart folders.

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,
"versionTest": "less-than",
"versionValue": "string",
"idValue": 0,
"idTest": "less-than"
}
],
"sortByObjectID": true
}

Response samples

application/json

{"smartFolders": [{"name": "string",
"parentSmartFolderID": 0,
"type": "standard",
"ruleGroups": [{"rules": [{"key": "general-host-name",
"comparisonOperator": "equals",
"value": "string",
"secondaryComparisonOperator": "equals",
"secondaryValue": "string",
"timeUnit": "minutes"
}
],
"logicalOperator": "and"
}
],
"tagFolder": {"cloudPlatform": "aws",
"cloudTagOrLabelKey": "string"
},
"logicalOperator": "and",
"duplicateOf": 0,
"ID": 0
}
]
}

➔ Next to Policies