Agent Scan Controls

Retrieve AgentScanControl setting details

get/agentscancontrols

Retrieve max concurrent agent scans on each ESX host setting.

Related SDK Methods:
Java

AgentScanControlsApi.listAgentScanControlSetting([param1, param2, ...])

Python

AgentScanControlsApi.list_agent_scan_control_setting([param1, param2, ...])

JavaScript

AgentScanControlsApi.listAgentScanControlSetting([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 retrieve AgentScanControl settings.

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.AgentScanControlsApi;
import com.trendmicro.deepsecurity.model.AgentScanControlSettings;


public class ListAgentScanControlSettingExample {
	
	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
		AgentScanControlsApi instance = new AgentScanControlsApi();
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			AgentScanControlSettings result = instance.listAgentScanControlSetting(apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling AgentScanControlsApi.listAgentScanControlSetting");
			e.printStackTrace();
		}
	}
}

Response samples
application/json
{
  • "maxConcurrentAgentScansOnEsx": 0
}

Modify AgentScanControl setting

post/agentscancontrols

Modify max concurrent agent scans on each ESX host setting.

Related SDK Methods:
Java

AgentScanControlsApi.modifyAgentScanControlSetting([param1, param2, ...])

Python

AgentScanControlsApi.modify_agent_scan_control_setting([param1, param2, ...])

JavaScript

AgentScanControlsApi.modifyAgentScanControlSetting([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

AgentScanControl setting details.

maxConcurrentAgentScansOnEsx
integer <int32>

Max concurrent agent scans on each ESX host.

Responses
200

successful operation

403

Not authorized to change AgentScanControl settings.

Request samples
application/json
{
  • "maxConcurrentAgentScansOnEsx": 0
}
Response samples
application/json
{
  • "maxConcurrentAgentScansOnEsx": 0
}