keyboard_arrow_down
  • 12.0
  • 20.0

USB Storage Devices

List USB Storage Devices

get/usbdevices

Lists all USB storage devices.

Related SDK Methods:
Java

UsbStorageDevicesApi.listUSBDevices([param1, param2, ...])
Python

USBStorageDevicesApi.list_usb_devices([param1, param2, ...])
JavaScript

USBStorageDevicesApi.listUSBDevices([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

User or API key is not authorized to view devices.

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.UsbStorageDevicesApi;
import com.trendmicro.deepsecurity.model.USBDevices;


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

Create a USB Storage Device

post/usbdevices

Create a new USB storage device.

Related SDK Methods:
Java

UsbStorageDevicesApi.createUSBDevice([param1, param2, ...])
Python

USBStorageDevicesApi.create_usb_device([param1, param2, ...])
JavaScript

USBStorageDevicesApi.createUSBDevice([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 USB storage device to create.

model
string

Model of the USB Storage Device. Searchable as String.

name
string

Name of the USB Storage Device. Searchable as String.

serialNumber
string

Serial Number of the USB Storage Device. Searchable as String.

vendor
string

Vendor of the USB Storage Device. Searchable as String.

Responses
200

successful operation

403

User or API key is not authorized to create devices.

Request samples
application/json
{
  • "name": "string",
  • "vendor": "string",
  • "model": "string",
  • "serialNumber": "string"
}
Response samples
application/json
{
  • "name": "string",
  • "vendor": "string",
  • "model": "string",
  • "serialNumber": "string",
  • "ID": 0
}

Search USB Storage Devices

post/usbdevices/search

Search for USB storage devices using optional filters.

Related SDK Methods:
Java

UsbStorageDevicesApi.searchUSBDevices([param1, param2, ...])
Python

USBStorageDevicesApi.search_usb_devices([param1, param2, ...])
JavaScript

USBStorageDevicesApi.searchUSBDevices([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

User or API key is not authorized to view devices.

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

Describe a USB Storage Device

get/usbdevices/{deviceID}

Describe a USB storage device by ID.

Related SDK Methods:
Java

UsbStorageDevicesApi.describeUSBDevice([param1, param2, ...])
Python

USBStorageDevicesApi.describe_usb_device([param1, param2, ...])
JavaScript

USBStorageDevicesApi.describeUSBDevice([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
deviceID
required
integer <int64> \d+

The ID number of the USB storage device 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

User or API key is not authorized to view devices.

404

The device 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.UsbStorageDevicesApi;
import com.trendmicro.deepsecurity.model.USBDevice;


public class DescribeUSBDeviceExample {
	
	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
		UsbStorageDevicesApi instance = new UsbStorageDevicesApi();
		Long deviceID = 1L;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			USBDevice result = instance.describeUSBDevice(deviceID, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling UsbStorageDevicesApi.describeUSBDevice");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "name": "string",
  • "vendor": "string",
  • "model": "string",
  • "serialNumber": "string",
  • "ID": 0
}

Modify a USB Storage Device

post/usbdevices/{deviceID}

Modify a USB storage device by ID. Any unset elements will be left unchanged.

Related SDK Methods:
Java

UsbStorageDevicesApi.modifyUSBDevice([param1, param2, ...])
Python

USBStorageDevicesApi.modify_usb_device([param1, param2, ...])
JavaScript

USBStorageDevicesApi.modifyUSBDevice([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
deviceID
required
integer <int64> \d+

The ID number of the USB storage device 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 USB storage device to modify.

model
string

Model of the USB Storage Device. Searchable as String.

name
string

Name of the USB Storage Device. Searchable as String.

serialNumber
string

Serial Number of the USB Storage Device. Searchable as String.

vendor
string

Vendor of the USB Storage Device. Searchable as String.

Responses
200

successful operation

403

User or API key is not authorized to modify devices or the requested modification is not permitted.

404

The device does not exist.

Request samples
application/json
{
  • "name": "string",
  • "vendor": "string",
  • "model": "string",
  • "serialNumber": "string"
}
Response samples
application/json
{
  • "name": "string",
  • "vendor": "string",
  • "model": "string",
  • "serialNumber": "string",
  • "ID": 0
}

Delete a USB Storage Device

delete/usbdevices/{deviceID}

Delete a USB storage device by ID.

Related SDK Methods:
Java

UsbStorageDevicesApi.deleteUSBDevice([param1, param2, ...])
Python

USBStorageDevicesApi.delete_usb_device([param1, param2, ...])
JavaScript

USBStorageDevicesApi.deleteUSBDevice([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
deviceID
required
integer <int64> \d+

The ID number of the USB storage device 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

User or API key is not authorized to delete devices.

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


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

List Device Exception Rules

get/usbdevices/{deviceID}/computerexceptionrules

Lists device exception rules for this device assigned to computers.

Related SDK Methods:
Java

UsbStorageDevicesApi.listComputerExceptionRules([param1, param2, ...])
Python

USBStorageDevicesApi.list_computer_exception_rules([param1, param2, ...])
JavaScript

USBStorageDevicesApi.listComputerExceptionRules([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
deviceID
required
integer <int64> \d+

The ID number of the USB storage device.

Example: 1
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

successful operation

403

User or API key is not authorized to view devices.

404

The device 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.UsbStorageDevicesApi;
import com.trendmicro.deepsecurity.model.ComputerExceptionRules;


public class ListComputerExceptionRulesExample {
	
	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
		UsbStorageDevicesApi instance = new UsbStorageDevicesApi();
		Long deviceID = 1L;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			ComputerExceptionRules result = instance.listComputerExceptionRules(deviceID, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling UsbStorageDevicesApi.listComputerExceptionRules");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "computers": [
    ]
}

List Device Exception Rules

get/usbdevices/{deviceID}/policyexceptionrules

Lists device exception rules for this device assigned to policies.

Related SDK Methods:
Java

UsbStorageDevicesApi.listPolicyExceptionRules([param1, param2, ...])
Python

USBStorageDevicesApi.list_policy_exception_rules([param1, param2, ...])
JavaScript

USBStorageDevicesApi.listPolicyExceptionRules([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
deviceID
required
integer <int64> \d+

The ID number of the USB storage device.

Example: 1
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

successful operation

403

User or API key is not authorized to view devices.

404

The device 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.UsbStorageDevicesApi;
import com.trendmicro.deepsecurity.model.PolicyExceptionRules;


public class ListPolicyExceptionRulesExample {
	
	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
		UsbStorageDevicesApi instance = new UsbStorageDevicesApi();
		Long deviceID = 1L;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			PolicyExceptionRules result = instance.listPolicyExceptionRules(deviceID, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling UsbStorageDevicesApi.listPolicyExceptionRules");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "policies": [
    ]
}