keyboard_arrow_down
  • 12.0
  • 20.0

Computers

Describe a Computer

get/computers/{computerID}

Describe a computer by ID.

Related SDK Methods:
Java

ComputersApi.describeComputer([param1, param2, ...])
Python

ComputersApi.describe_computer([param1, param2, ...])
JavaScript

ComputersApi.describeComputer([param1, param2, ...])

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

The ID number of the computer to describe.

Example: 1
query Parameters
expand
Array of strings

Determines the computer information to include in the response. Use "none" to retrieve only basic computer information such as policyID and hostName. Use one or several expand options to retrieve a tailored response in addition to the basic information. Use "all" to retrieve all of the computer information. The default is "all", but we recommend using expand on all requests to improve performance.

Items Enum: "none" "all" "computerStatus" "tasks" "securityUpdates" "computerSettings" "allSecurityModules" "antiMalware" "webReputation" "firewall" "intrusionPrevention" "integrityMonitoring" "logInspection" "applicationControl" "SAP" "interfaces" "ESXSummary" "allVirtualMachineSummaries" "azureARMVirtualMachineSummary" "azureVMVirtualMachineSummary" "ec2VirtualMachineSummary" "noConnectorVirtualMachineSummary" "vmwareVMVirtualMachineSummary" "vcloudVMVirtualMachineSummary" "workspaceVirtualMachineSummary"
overrides
boolean

Show only overrides defined for the current computer.

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 computers.

404

The computer 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.ComputersApi;
import com.trendmicro.deepsecurity.model.Computer;
import com.trendmicro.deepsecurity.model.Expand;

import java.util.List;

public class DescribeComputerExample {
	
	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
		ComputersApi instance = new ComputersApi();
		Integer computerID = 1;
		List<String> expand = new Expand(Expand.OptionsEnum.NONE).list();
		Boolean overrides = false;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			Computer result = instance.describeComputer(computerID, expand, overrides, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling ComputersApi.describeComputer");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "hostName": "string",
  • "displayName": "string",
  • "description": "string",
  • "lastIPUsed": "string",
  • "platform": "string",
  • "groupID": 0,
  • "policyID": 0,
  • "assetImportanceID": 0,
  • "relayListID": 0,
  • "agentFingerPrint": "string",
  • "applianceFingerPrint": "string",
  • "lastAgentCommunication": 0,
  • "lastApplianceCommunication": 0,
  • "lastSendPolicyRequest": 0,
  • "lastSendPolicySuccess": 0,
  • "agentVersion": "string",
  • "computerStatus": {
    },
  • "tasks": {
    },
  • "securityUpdates": {
    },
  • "computerSettings": {
    },
  • "interfaces": {
    },
  • "biosUUID": "string",
  • "azureARMVirtualMachineSummary": {
    },
  • "azureVMVirtualMachineSummary": {
    },
  • "ec2VirtualMachineSummary": {
    },
  • "noConnectorVirtualMachineSummary": {
    },
  • "vmwareVMVirtualMachineSummary": {
    },
  • "vcloudVMVirtualMachineSummary": {
    },
  • "workspaceVirtualMachineSummary": {
    },
  • "ID": 0,
  • "antiMalware": {
    },
  • "webReputation": {
    },
  • "firewall": {
    },
  • "intrusionPrevention": {
    },
  • "integrityMonitoring": {
    },
  • "logInspection": {
    },
  • "applicationControl": {
    },
  • "SAP": {
    },
  • "ESXSummary": {
    }
}

Modify a Computer

post/computers/{computerID}

Modify a computer by ID.

Related SDK Methods:
Java

ComputersApi.modifyComputer([param1, param2, ...])
Python

ComputersApi.modify_computer([param1, param2, ...])
JavaScript

ComputersApi.modifyComputer([param1, param2, ...])

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

The ID number of the computer to modify.

Example: 1
query Parameters
overrides
boolean

Show only overrides defined for the current computer.

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 computer to modify.

object (AntiMalwareComputerExtension)

Computer-level configuration for the Anti-Malware module.

object (ApplicationControlComputerExtension)

Computer-level configuration for the Application Control module.

assetImportanceID
integer <int32>

ID of the asset importance assigned to the computer. Searchable as Numeric.

object (azureARMVirtualMachineSummary)

Details of an Azure virtual machine that is managed using the Azure Resource Manager (ARM).

object (azureVMVirtualMachineSummary)

Details for an Azure virtual machine.

object (ComputerSettings)
object (computerStatus)

Computer status details.

description
string

Description of the computer. Searchable as String.

displayName
string

Display name of the computer. Searchable as String.

object (ec2VirtualMachineSummary)

Details of an AWS EC2 virtual machine.

object (ESXSummary)

VMware ESX Host Information.

object (FirewallComputerExtension)

Computer-level configuration for the Firewall module.

groupID
integer <int32>

ID of the computer group to which the computer belongs. Searchable as Numeric.

hostName
string

Hostname of the computer. Searchable as String.

object (IntegrityMonitoringComputerExtension)

Computer-level configuration for the Integrity Monitoring module.

object (Interfaces)
object (IntrusionPreventionComputerExtension)

Computer-level configuration for the Intrusion Prevention module.

object (LogInspectionComputerExtension)

Computer-level configuration for the Log Inspection module.

object (noConnectorVirtualMachineSummary)

Details of an AWS virtual machine that was added to Deep Security Manager using the legacy Add Cloud Account wizard.

policyID
integer <int32>

ID of the policy assigned to the computer. Searchable as Numeric.

relayListID
integer <int32>

ID of the relay list that is assigned to the computer. Searchable as Numeric.

object (SAPComputerExtension)

Computer-level configuration for the Scanner module (SAP integration).

object (securityUpdates)

Security update details.

object (computerTasks)

Computer task details.

object (vcloudVMVirtualMachineSummary)

Details of a vCloud virtual machine.

object (vmwareVMVirtualMachineSummary)

Details of a VMWare virtual machine.

object (WebReputationComputerExtension)

Computer-level configuration for the Web Reputation module.

object (workspaceVirtualMachineSummary)

Details of an AWS Workspace.

Responses
200

successful operation

403

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

404

The computer does not exist.

Request samples
application/json
{
  • "hostName": "string",
  • "displayName": "string",
  • "description": "string",
  • "groupID": 0,
  • "policyID": 0,
  • "assetImportanceID": 0,
  • "relayListID": 0,
  • "computerStatus": { },
  • "tasks": { },
  • "securityUpdates": {
    },
  • "computerSettings": {
    },
  • "interfaces": {
    },
  • "azureARMVirtualMachineSummary": {
    },
  • "azureVMVirtualMachineSummary": {
    },
  • "ec2VirtualMachineSummary": {
    },
  • "noConnectorVirtualMachineSummary": {
    },
  • "vmwareVMVirtualMachineSummary": {
    },
  • "vcloudVMVirtualMachineSummary": {
    },
  • "workspaceVirtualMachineSummary": {
    },
  • "antiMalware": {
    },
  • "webReputation": {
    },
  • "firewall": {
    },
  • "intrusionPrevention": {
    },
  • "integrityMonitoring": {
    },
  • "logInspection": {
    },
  • "applicationControl": {
    },
  • "SAP": {
    },
  • "ESXSummary": {
    }
}
Response samples
application/json
{
  • "hostName": "string",
  • "displayName": "string",
  • "description": "string",
  • "lastIPUsed": "string",
  • "platform": "string",
  • "groupID": 0,
  • "policyID": 0,
  • "assetImportanceID": 0,
  • "relayListID": 0,
  • "agentFingerPrint": "string",
  • "applianceFingerPrint": "string",
  • "lastAgentCommunication": 0,
  • "lastApplianceCommunication": 0,
  • "lastSendPolicyRequest": 0,
  • "lastSendPolicySuccess": 0,
  • "agentVersion": "string",
  • "computerStatus": {
    },
  • "tasks": {
    },
  • "securityUpdates": {
    },
  • "computerSettings": {
    },
  • "interfaces": {
    },
  • "biosUUID": "string",
  • "azureARMVirtualMachineSummary": {
    },
  • "azureVMVirtualMachineSummary": {
    },
  • "ec2VirtualMachineSummary": {
    },
  • "noConnectorVirtualMachineSummary": {
    },
  • "vmwareVMVirtualMachineSummary": {
    },
  • "vcloudVMVirtualMachineSummary": {
    },
  • "workspaceVirtualMachineSummary": {
    },
  • "ID": 0,
  • "antiMalware": {
    },
  • "webReputation": {
    },
  • "firewall": {
    },
  • "intrusionPrevention": {
    },
  • "integrityMonitoring": {
    },
  • "logInspection": {
    },
  • "applicationControl": {
    },
  • "SAP": {
    },
  • "ESXSummary": {
    }
}

Delete a Computer

delete/computers/{computerID}

Delete a computer by ID.

Related SDK Methods:
Java

ComputersApi.deleteComputer([param1, param2, ...])
Python

ComputersApi.delete_computer([param1, param2, ...])
JavaScript

ComputersApi.deleteComputer([param1, param2, ...])

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

The ID number of the computer 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 computers.

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


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

List Computers

get/computers

Lists all computers.

Related SDK Methods:
Java

ComputersApi.listComputers([param1, param2, ...])
Python

ComputersApi.list_computers([param1, param2, ...])
JavaScript

ComputersApi.listComputers([param1, param2, ...])

Request
Security:
DefaultAuthentication
query Parameters
expand
Array of strings

Determines the computer information to include in the response. Use "none" to retrieve only basic computer information such as policyID and hostName. Use one or several expand options to retrieve a tailored response in addition to the basic information. Use "all" to retrieve all of the computer information. The default is "all", but we recommend using expand on all requests to improve performance.

Items Enum: "none" "all" "computerStatus" "tasks" "securityUpdates" "computerSettings" "allSecurityModules" "antiMalware" "webReputation" "firewall" "intrusionPrevention" "integrityMonitoring" "logInspection" "applicationControl" "SAP" "interfaces" "ESXSummary" "allVirtualMachineSummaries" "azureARMVirtualMachineSummary" "azureVMVirtualMachineSummary" "ec2VirtualMachineSummary" "noConnectorVirtualMachineSummary" "vmwareVMVirtualMachineSummary" "vcloudVMVirtualMachineSummary" "workspaceVirtualMachineSummary"
overrides
boolean

Show only overrides defined for the current computer.

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 computers.

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.ComputersApi;
import com.trendmicro.deepsecurity.model.Computers;
import com.trendmicro.deepsecurity.model.Expand;

import java.util.List;

public class ListComputersExample {
	
	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
		ComputersApi instance = new ComputersApi();
		List<String> expand = new Expand(Expand.OptionsEnum.NONE).list();
		Boolean overrides = false;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			Computers result = instance.listComputers(expand, overrides, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling ComputersApi.listComputers");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "computers": [
    ]
}

Create a Computer

post/computers

Create a new computer.

Related SDK Methods:
Java

ComputersApi.createComputer([param1, param2, ...])
Python

ComputersApi.create_computer([param1, param2, ...])
JavaScript

ComputersApi.createComputer([param1, param2, ...])

Request
Security:
DefaultAuthentication
query Parameters
overrides
boolean

Show only overrides defined for the current computer.

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 computer.

object (AntiMalwareComputerExtension)

Computer-level configuration for the Anti-Malware module.

object (ApplicationControlComputerExtension)

Computer-level configuration for the Application Control module.

assetImportanceID
integer <int32>

ID of the asset importance assigned to the computer. Searchable as Numeric.

object (azureARMVirtualMachineSummary)

Details of an Azure virtual machine that is managed using the Azure Resource Manager (ARM).

object (azureVMVirtualMachineSummary)

Details for an Azure virtual machine.

object (ComputerSettings)
object (computerStatus)

Computer status details.

description
string

Description of the computer. Searchable as String.

displayName
string

Display name of the computer. Searchable as String.

object (ec2VirtualMachineSummary)

Details of an AWS EC2 virtual machine.

object (ESXSummary)

VMware ESX Host Information.

object (FirewallComputerExtension)

Computer-level configuration for the Firewall module.

groupID
integer <int32>

ID of the computer group to which the computer belongs. Searchable as Numeric.

hostName
string

Hostname of the computer. Searchable as String.

object (IntegrityMonitoringComputerExtension)

Computer-level configuration for the Integrity Monitoring module.

object (Interfaces)
object (IntrusionPreventionComputerExtension)

Computer-level configuration for the Intrusion Prevention module.

object (LogInspectionComputerExtension)

Computer-level configuration for the Log Inspection module.

object (noConnectorVirtualMachineSummary)

Details of an AWS virtual machine that was added to Deep Security Manager using the legacy Add Cloud Account wizard.

policyID
integer <int32>

ID of the policy assigned to the computer. Searchable as Numeric.

relayListID
integer <int32>

ID of the relay list that is assigned to the computer. Searchable as Numeric.

object (SAPComputerExtension)

Computer-level configuration for the Scanner module (SAP integration).

object (securityUpdates)

Security update details.

object (computerTasks)

Computer task details.

object (vcloudVMVirtualMachineSummary)

Details of a vCloud virtual machine.

object (vmwareVMVirtualMachineSummary)

Details of a VMWare virtual machine.

object (WebReputationComputerExtension)

Computer-level configuration for the Web Reputation module.

object (workspaceVirtualMachineSummary)

Details of an AWS Workspace.

Responses
200

successful operation

403

Not authorized to create computers.

Request samples
application/json
{
  • "hostName": "string",
  • "displayName": "string",
  • "description": "string",
  • "groupID": 0,
  • "policyID": 0,
  • "assetImportanceID": 0,
  • "relayListID": 0,
  • "computerStatus": { },
  • "tasks": { },
  • "securityUpdates": {
    },
  • "computerSettings": {
    },
  • "interfaces": {
    },
  • "azureARMVirtualMachineSummary": {
    },
  • "azureVMVirtualMachineSummary": {
    },
  • "ec2VirtualMachineSummary": {
    },
  • "noConnectorVirtualMachineSummary": {
    },
  • "vmwareVMVirtualMachineSummary": {
    },
  • "vcloudVMVirtualMachineSummary": {
    },
  • "workspaceVirtualMachineSummary": {
    },
  • "antiMalware": {
    },
  • "webReputation": {
    },
  • "firewall": {
    },
  • "intrusionPrevention": {
    },
  • "integrityMonitoring": {
    },
  • "logInspection": {
    },
  • "applicationControl": {
    },
  • "SAP": {
    },
  • "ESXSummary": {
    }
}
Response samples
application/json
{
  • "hostName": "string",
  • "displayName": "string",
  • "description": "string",
  • "lastIPUsed": "string",
  • "platform": "string",
  • "groupID": 0,
  • "policyID": 0,
  • "assetImportanceID": 0,
  • "relayListID": 0,
  • "agentFingerPrint": "string",
  • "applianceFingerPrint": "string",
  • "lastAgentCommunication": 0,
  • "lastApplianceCommunication": 0,
  • "lastSendPolicyRequest": 0,
  • "lastSendPolicySuccess": 0,
  • "agentVersion": "string",
  • "computerStatus": {
    },
  • "tasks": {
    },
  • "securityUpdates": {
    },
  • "computerSettings": {
    },
  • "interfaces": {
    },
  • "biosUUID": "string",
  • "azureARMVirtualMachineSummary": {
    },
  • "azureVMVirtualMachineSummary": {
    },
  • "ec2VirtualMachineSummary": {
    },
  • "noConnectorVirtualMachineSummary": {
    },
  • "vmwareVMVirtualMachineSummary": {
    },
  • "vcloudVMVirtualMachineSummary": {
    },
  • "workspaceVirtualMachineSummary": {
    },
  • "ID": 0,
  • "antiMalware": {
    },
  • "webReputation": {
    },
  • "firewall": {
    },
  • "intrusionPrevention": {
    },
  • "integrityMonitoring": {
    },
  • "logInspection": {
    },
  • "applicationControl": {
    },
  • "SAP": {
    },
  • "ESXSummary": {
    }
}

Search Computers

post/computers/search

Search for computers using optional filters.

Related SDK Methods:
Java

ComputersApi.searchComputers([param1, param2, ...])
Python

ComputersApi.search_computers([param1, param2, ...])
JavaScript

ComputersApi.searchComputers([param1, param2, ...])

Request
Security:
DefaultAuthentication
query Parameters
expand
Array of strings

Determines the computer information to include in the response. Use "none" to retrieve only basic computer information such as policyID and hostName. Use one or several expand options to retrieve a tailored response in addition to the basic information. Use "all" to retrieve all of the computer information. The default is "all", but we recommend using expand on all requests to improve performance.

Items Enum: "none" "all" "computerStatus" "tasks" "securityUpdates" "computerSettings" "allSecurityModules" "antiMalware" "webReputation" "firewall" "intrusionPrevention" "integrityMonitoring" "logInspection" "applicationControl" "SAP" "interfaces" "ESXSummary" "allVirtualMachineSummaries" "azureARMVirtualMachineSummary" "azureVMVirtualMachineSummary" "ec2VirtualMachineSummary" "noConnectorVirtualMachineSummary" "vmwareVMVirtualMachineSummary" "vcloudVMVirtualMachineSummary" "workspaceVirtualMachineSummary"
overrides
boolean

Show only overrides defined for the current computer.

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 computers.

Request samples
application/json
{
  • "maxItems": 0,
  • "searchCriteria": [
    ],
  • "sortByObjectID": true
}
Response samples
application/json
{
  • "computers": [
    ]
}
➔ Next to Computer Firewall Rule Assignments