Agent Version Controls

Describe an agent version control

get/agentversioncontrolprofiles/{agentVersionControlProfileID}/agentversioncontrols/{agentVersionControlID}

Describe an Agent Version Control by ID.

Related SDK Methods:

Java

AgentVersionControlsApi.describeAgentVersionControl([param1, param2, ...])

Python

AgentVersionControlsApi.describe_agent_version_control([param1, param2, ...])

JavaScript

AgentVersionControlsApi.describeAgentVersionControl([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key

Request

path Parameters

agentVersionControlID required	integer <int32> \d+ The ID number of the agent version control to describe. Example: 1
agentVersionControlProfileID required	integer <int32> \d+ The ID number of the agent version control profile. Example: 1

header Parameters

api-version

required

string

The version of the api being called.

Example: YOUR VERSION

Responses

200

successful operation

404

The agent version control does not exist.

Request samples

Java
Python
JavaScript

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.AgentVersionControlsApi;
import com.trendmicro.deepsecurity.model.AgentVersionControl;


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

Response samples

application/json

{"os": "Windows",
"distro": "Red Hat",
"platform": "Microsoft Windows 2000 Server",
"architecture": "32-bit",
"type": "latest",
"version": "string",
"availableVersions": [{"version": "string",
"isLatest": true,
"isLatestLTS": true
}
],
"ID": 0
}

List agent version controls

get/agentversioncontrolprofiles/{agentVersionControlProfileID}/agentversioncontrols

Lists all agent version controls.

Related SDK Methods:

Java

AgentVersionControlsApi.listAgentVersionControls([param1, param2, ...])

Python

AgentVersionControlsApi.list_agent_version_controls([param1, param2, ...])

JavaScript

AgentVersionControlsApi.listAgentVersionControls([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key

Request

path Parameters

agentVersionControlProfileID

required

integer <int32> \d+

The ID number of the agent version control profile.

Example: 1

header Parameters

api-version

required

string

The version of the api being called.

Example: YOUR VERSION

Responses

200

successful operation

Request samples

Java
Python
JavaScript

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.AgentVersionControlsApi;
import com.trendmicro.deepsecurity.model.AgentVersionControls;


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

Response samples

application/json

{"agentVersionControls": [{"os": "Windows",
"distro": "Red Hat",
"platform": "Microsoft Windows 2000 Server",
"architecture": "32-bit",
"type": "latest",
"version": "string",
"availableVersions": [{"version": "string",
"isLatest": true,
"isLatestLTS": true
}
],
"ID": 0
}
]
}

Modify agent version controls

post/agentversioncontrolprofiles/{agentVersionControlProfileID}/agentversioncontrols

Modify the agent version controls. Any unset elements will be left unchanged.

Related SDK Methods:

Java

AgentVersionControlsApi.modifyAgentVersionControls([param1, param2, ...])

Python

AgentVersionControlsApi.modify_agent_version_controls([param1, param2, ...])

JavaScript

AgentVersionControlsApi.modifyAgentVersionControls([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key

Request

path Parameters

agentVersionControlProfileID

required

integer <int32> \d+

The ID number of the agent version control profile.

Example: 1

header Parameters

api-version

required

string

The version of the api being called.

Example: YOUR VERSION

Request Body schema: application/json

The agent version controls to modify.

Array of objects (agentVersionControl)

Responses

200

successful operation

Request samples

Payload
Java
Python
JavaScript

application/json

{"agentVersionControls": [{"type": "latest",
"version": "string",
"ID": 0
}
]
}

Response samples

application/json

{"agentVersionControls": [{"os": "Windows",
"distro": "Red Hat",
"platform": "Microsoft Windows 2000 Server",
"architecture": "32-bit",
"type": "latest",
"version": "string",
"availableVersions": [{"version": "string",
"isLatest": true,
"isLatestLTS": true
}
],
"ID": 0
}
]
}

Search agent version controls

post/agentversioncontrolprofiles/{agentVersionControlProfileID}/agentversioncontrols/search

Search for agent version controls using optional filters.

Related SDK Methods:

Java

AgentVersionControlsApi.searchAgentVersionControls([param1, param2, ...])

Python

AgentVersionControlsApi.search_agent_version_controls([param1, param2, ...])

JavaScript

AgentVersionControlsApi.searchAgentVersionControls([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key

Request

path Parameters

agentVersionControlProfileID

required

integer <int32> \d+

The ID number of the agent version control profile.

Example: 1

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

Request samples

Payload
Java
Python
JavaScript

application/json

{"maxItems": 0,
"searchCriteria": [{"fieldName": "string",
"booleanTest": true,
"numericTest": "less-than",
"numericValue": 0,
"numericValueList": [0
],
"stringTest": "equal",
"stringValue": "string",
"stringWildcards": true,
"choiceTest": "equal",
"choiceValue": "string",
"firstDateValue": 0,
"firstDateInclusive": true,
"lastDateValue": 0,
"lastDateInclusive": true,
"nullTest": true,
"versionTest": "less-than",
"versionValue": "string",
"idValue": 0,
"idTest": "less-than",
"idValueList": [0
]
}
],
"sortByObjectID": true
}

Response samples

application/json

{"agentVersionControls": [{"os": "Windows",
"distro": "Red Hat",
"platform": "Microsoft Windows 2000 Server",
"architecture": "32-bit",
"type": "latest",
"version": "string",
"availableVersions": [{"version": "string",
"isLatest": true,
"isLatestLTS": true
}
],
"ID": 0
}
]
}

➔ Next to Agent Version Control Profiles