keyboard_arrow_down
  • 12.0
  • 20.0

File Lists

List File Lists

get/filelists

Lists all file lists.

Related SDK Methods:
Java

FileListsApi.listFileLists([param1, param2, ...])
Python

FileListsApi.list_file_lists([param1, param2, ...])
JavaScript

FileListsApi.listFileLists([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 file lists.

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.FileListsApi;
import com.trendmicro.deepsecurity.model.FileLists;


public class ListFileListsExample {
	
	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
		FileListsApi instance = new FileListsApi();
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			FileLists result = instance.listFileLists(apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling FileListsApi.listFileLists");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "fileLists": [
    ]
}

Create a File List

post/filelists

Create a new file list.

Related SDK Methods:
Java

FileListsApi.createFileList([param1, param2, ...])
Python

FileListsApi.create_file_list([param1, param2, ...])
JavaScript

FileListsApi.createFileList([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 file list.

description
string

Description of the file list. Searchable as String.

items
Array of strings

List of file paths. Asterisk (*) is a wildcard character.

name
string

Name of the file list. Searchable as String.

Responses
200

successful operation

403

Not authorized to create file lists.

Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "items": [
    ]
}
Response samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "items": [
    ],
  • "ID": 0
}

Search File Lists

post/filelists/search

Search for file lists using optional filters.

Related SDK Methods:
Java

FileListsApi.searchFileLists([param1, param2, ...])
Python

FileListsApi.search_file_lists([param1, param2, ...])
JavaScript

FileListsApi.searchFileLists([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 file lists.

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

Describe a File List

get/filelists/{fileListID}

Describe a file list by ID.

Related SDK Methods:
Java

FileListsApi.describeFileList([param1, param2, ...])
Python

FileListsApi.describe_file_list([param1, param2, ...])
JavaScript

FileListsApi.describeFileList([param1, param2, ...])

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

The ID number of the anti-malware 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 file lists.

404

The file list 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.FileListsApi;
import com.trendmicro.deepsecurity.model.FileList;


public class DescribeFileListExample {
	
	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
		FileListsApi instance = new FileListsApi();
		Integer fileListID = 1;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			FileList result = instance.describeFileList(fileListID, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling FileListsApi.describeFileList");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "items": [
    ],
  • "ID": 0
}

Modify a File List

post/filelists/{fileListID}

Modify a file list by ID. Any unset elements will be left unchanged.

Related SDK Methods:
Java

FileListsApi.modifyFileList([param1, param2, ...])
Python

FileListsApi.modify_file_list([param1, param2, ...])
JavaScript

FileListsApi.modifyFileList([param1, param2, ...])

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

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

description
string

Description of the file list. Searchable as String.

items
Array of strings

List of file paths. Asterisk (*) is a wildcard character.

name
string

Name of the file list. Searchable as String.

Responses
200

successful operation

403

Not authorized to modify file lists or the requested modification is not permitted.

404

The file list does not exist.

Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "items": [
    ]
}
Response samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "items": [
    ],
  • "ID": 0
}

Delete a File List

delete/filelists/{fileListID}

Delete a file list by ID.

Related SDK Methods:
Java

FileListsApi.deleteFileList([param1, param2, ...])
Python

FileListsApi.delete_file_list([param1, param2, ...])
JavaScript

FileListsApi.deleteFileList([param1, param2, ...])

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

The ID number of the file list 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 file lists.

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


public class DeleteFileListExample {
	
	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
		FileListsApi instance = new FileListsApi();
		Integer fileListID = 1;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			instance.deleteFileList(fileListID, apiVersion);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling FileListsApi.deleteFileList");
			e.printStackTrace();
		}
	}
}
➔ Next to Schedules