Computer Groups

List Computer Groups

get/computergroups

Lists all computer groups.

Related SDK Methods:
Java

ComputerGroupsApi.listComputerGroups([param1, param2, ...])

Python

ComputerGroupsApi.list_computer_groups([param1, param2, ...])

JavaScript

ComputerGroupsApi.listComputerGroups([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key
Request
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 computer groups.

Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.ComputerGroupsApi;
import com.trendmicro.deepsecurity.model.ComputerGroups;


public class ListComputerGroupsExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth Legacy API Key = (ApiKeyAuth) defaultClient.getAuthentication("Legacy API Key");
		Legacy API Key.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		ApiKeyAuth Trend Micro Cloud One API Key = (ApiKeyAuth) defaultClient.getAuthentication("Trend Micro Cloud One API Key");
		Trend Micro Cloud One API Key.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
		ComputerGroupsApi instance = new ComputerGroupsApi();
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			ComputerGroups result = instance.listComputerGroups(apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling ComputerGroupsApi.listComputerGroups");
			e.printStackTrace();
		}
	}
}

Response samples
application/json
{
  • "computerGroups": [
    ]
}

Create a Computer Group

post/computergroups

Create a new computer group.

Related SDK Methods:
Java

ComputerGroupsApi.createComputerGroup([param1, param2, ...])

Python

ComputerGroupsApi.create_computer_group([param1, param2, ...])

JavaScript

ComputerGroupsApi.createComputerGroup([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key
Request
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 group.

description
string

Description of the ComputerGroup. Searchable as String.

name
string

Name of the ComputerGroup. Searchable as String.

parentGroupID
integer <int32>

ID of the ComputerGroup's parent group. Empty if the parent is a root ComputerGroup. ComputerGroup will be a root group unless a valid value for parentGroupID is set. Searchable as Numeric.

Responses
200

successful operation

403

Not authorized to create computer groups.

Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "parentGroupID": 0
}
Response samples
application/json
{
  • "type": "ad-add-directory",
  • "name": "string",
  • "description": "string",
  • "parentGroupID": 0,
  • "directoryID": 0,
  • "externalID": "string",
  • "virtualID": 0,
  • "virtualType": 0,
  • "virtualName": "string",
  • "cloudType": "amazon",
  • "cloudResourceType": "physical",
  • "cloudID": 0,
  • "amazonAccountID": 0,
  • "amazonRegionID": 0,
  • "amazonVPCID": 0,
  • "amazonSubnetID": 0,
  • "amazonWorkspacesID": 0,
  • "amazonDirectoryID": 0,
  • "ID": 0
}

Search Computer Groups

post/computergroups/search

Search for computer groups using optional filters.

Related SDK Methods:
Java

ComputerGroupsApi.searchComputerGroups([param1, param2, ...])

Python

ComputerGroupsApi.search_computer_groups([param1, param2, ...])

JavaScript

ComputerGroupsApi.searchComputerGroups([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key
Request
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 computer groups.

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

Describe a Computer Group

get/computergroups/{computerGroupID}

Describe a computer group by ID.

Related SDK Methods:
Java

ComputerGroupsApi.describeComputerGroup([param1, param2, ...])

Python

ComputerGroupsApi.describe_computer_group([param1, param2, ...])

JavaScript

ComputerGroupsApi.describeComputerGroup([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key
Request
path Parameters
computerGroupID
required
integer <int32> \d+

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

404

The computer group 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.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.ComputerGroupsApi;
import com.trendmicro.deepsecurity.model.ComputerGroup;


public class DescribeComputerGroupExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth Legacy API Key = (ApiKeyAuth) defaultClient.getAuthentication("Legacy API Key");
		Legacy API Key.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		ApiKeyAuth Trend Micro Cloud One API Key = (ApiKeyAuth) defaultClient.getAuthentication("Trend Micro Cloud One API Key");
		Trend Micro Cloud One API Key.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
		ComputerGroupsApi instance = new ComputerGroupsApi();
		Integer computerGroupID = 1;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			ComputerGroup result = instance.describeComputerGroup(computerGroupID, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling ComputerGroupsApi.describeComputerGroup");
			e.printStackTrace();
		}
	}
}

Response samples
application/json
{
  • "type": "ad-add-directory",
  • "name": "string",
  • "description": "string",
  • "parentGroupID": 0,
  • "directoryID": 0,
  • "externalID": "string",
  • "virtualID": 0,
  • "virtualType": 0,
  • "virtualName": "string",
  • "cloudType": "amazon",
  • "cloudResourceType": "physical",
  • "cloudID": 0,
  • "amazonAccountID": 0,
  • "amazonRegionID": 0,
  • "amazonVPCID": 0,
  • "amazonSubnetID": 0,
  • "amazonWorkspacesID": 0,
  • "amazonDirectoryID": 0,
  • "ID": 0
}

Modify a Computer Group

post/computergroups/{computerGroupID}

Modify a computer group by ID. Any unset elements will be left unchanged.

Related SDK Methods:
Java

ComputerGroupsApi.modifyComputerGroup([param1, param2, ...])

Python

ComputerGroupsApi.modify_computer_group([param1, param2, ...])

JavaScript

ComputerGroupsApi.modifyComputerGroup([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key
Request
path Parameters
computerGroupID
required
integer <int32> \d+

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

description
string

Description of the ComputerGroup. Searchable as String.

name
string

Name of the ComputerGroup. Searchable as String.

parentGroupID
integer <int32>

ID of the ComputerGroup's parent group. Empty if the parent is a root ComputerGroup. ComputerGroup will be a root group unless a valid value for parentGroupID is set. Searchable as Numeric.

Responses
200

successful operation

403

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

404

The computer group does not exist.

Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "parentGroupID": 0
}
Response samples
application/json
{
  • "type": "ad-add-directory",
  • "name": "string",
  • "description": "string",
  • "parentGroupID": 0,
  • "directoryID": 0,
  • "externalID": "string",
  • "virtualID": 0,
  • "virtualType": 0,
  • "virtualName": "string",
  • "cloudType": "amazon",
  • "cloudResourceType": "physical",
  • "cloudID": 0,
  • "amazonAccountID": 0,
  • "amazonRegionID": 0,
  • "amazonVPCID": 0,
  • "amazonSubnetID": 0,
  • "amazonWorkspacesID": 0,
  • "amazonDirectoryID": 0,
  • "ID": 0
}

Delete a Computer Group

delete/computergroups/{computerGroupID}

Delete a computer group by ID.

Related SDK Methods:
Java

ComputerGroupsApi.deleteComputerGroup([param1, param2, ...])

Python

ComputerGroupsApi.delete_computer_group([param1, param2, ...])

JavaScript

ComputerGroupsApi.deleteComputerGroup([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key
Request
path Parameters
computerGroupID
required
integer <int32> \d+

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

Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.ComputerGroupsApi;


public class DeleteComputerGroupExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth Legacy API Key = (ApiKeyAuth) defaultClient.getAuthentication("Legacy API Key");
		Legacy API Key.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		ApiKeyAuth Trend Micro Cloud One API Key = (ApiKeyAuth) defaultClient.getAuthentication("Trend Micro Cloud One API Key");
		Trend Micro Cloud One API Key.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
		ComputerGroupsApi instance = new ComputerGroupsApi();
		Integer computerGroupID = 1;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			instance.deleteComputerGroup(computerGroupID, apiVersion);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling ComputerGroupsApi.deleteComputerGroup");
			e.printStackTrace();
		}
	}
}