keyboard_arrow_down
  • 12.0
  • 20.0

File Extension Lists

List File Extension Lists

get/fileextensionlists

Lists all file extension lists.

Related SDK Methods:
Java

FileExtensionListsApi.listFileExtensionLists([param1, param2, ...])
Python

FileExtensionListsApi.list_file_extension_lists([param1, param2, ...])
JavaScript

FileExtensionListsApi.listFileExtensionLists([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 extension 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.FileExtensionListsApi;
import com.trendmicro.deepsecurity.model.FileExtensionLists;


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

Create a File Extension List

post/fileextensionlists

Create a new file extension list.

Related SDK Methods:
Java

FileExtensionListsApi.createFileExtensionList([param1, param2, ...])
Python

FileExtensionListsApi.create_file_extension_list([param1, param2, ...])
JavaScript

FileExtensionListsApi.createFileExtensionList([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 extension list.

description
string

Description of the file extension list. Searchable as String.

items
Array of strings

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

name
string

Name of the file extension list. Searchable as String.

Responses
200

successful operation

403

Not authorized to create file extension lists.

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

Search File Extension Lists

post/fileextensionlists/search

Search for file extension lists using optional filters.

Related SDK Methods:
Java

FileExtensionListsApi.searchFileExtensionLists([param1, param2, ...])
Python

FileExtensionListsApi.search_file_extension_lists([param1, param2, ...])
JavaScript

FileExtensionListsApi.searchFileExtensionLists([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 extension lists.

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

Describe a File Extension List

get/fileextensionlists/{fileExtensionListID}

Describe a file extension list by ID.

Related SDK Methods:
Java

FileExtensionListsApi.describeFileExtensionList([param1, param2, ...])
Python

FileExtensionListsApi.describe_file_extension_list([param1, param2, ...])
JavaScript

FileExtensionListsApi.describeFileExtensionList([param1, param2, ...])

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

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

404

The file extension 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.FileExtensionListsApi;
import com.trendmicro.deepsecurity.model.FileExtensionList;


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

Modify a File Extension List

post/fileextensionlists/{fileExtensionListID}

Modify a file extension list by ID.

Related SDK Methods:
Java

FileExtensionListsApi.modifyFileExtensionList([param1, param2, ...])
Python

FileExtensionListsApi.modify_file_extension_list([param1, param2, ...])
JavaScript

FileExtensionListsApi.modifyFileExtensionList([param1, param2, ...])

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

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

description
string

Description of the file extension list. Searchable as String.

items
Array of strings

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

name
string

Name of the file extension list. Searchable as String.

Responses
200

successful operation

403

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

404

The file extension 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 Extension List

delete/fileextensionlists/{fileExtensionListID}

Delete a file extension list by ID.

Related SDK Methods:
Java

FileExtensionListsApi.deleteFileExtensionList([param1, param2, ...])
Python

FileExtensionListsApi.delete_file_extension_list([param1, param2, ...])
JavaScript

FileExtensionListsApi.deleteFileExtensionList([param1, param2, ...])

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

The ID number of the file extension 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 extension 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.FileExtensionListsApi;


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