Retrieves a list of managed product agents, such as OfficeScan agents.
GET /WebApp/API/AgentResource/ProductAgents
Parameter |
Type |
Description |
---|---|---|
Optional Parameters |
||
entity_id |
String |
The GUID of the managed product agent |
ip_address |
String |
The IP address of the managed product agent |
mac_address |
String |
The MAC address of the managed product agent |
host_name |
String |
The endpoint name of the managed product agent |
product |
String |
The Trend Micro product that the agent is for For available values, see Automation API Product Values. |
managing_server_id |
String |
The GUID of the product server that manages the agent |
GET /WebApp/API/ServerResource/ProductAgents? ip_address=192.168.121.132&mac_address=00-0C-29-9B-AB-65& host_name=OSCECLIENT
Specify a JSON object containing the following HTTP header:
HTTP header:
Field Name |
Value |
---|---|
Authorization |
Bearer [Generated JWT authentication token] |
Request body: [Blank]
If successful, this method returns an HTTP 200 OK status code and a response body where:
The "result_code" is 1
The "result_content" is a list of agents that match all of the specified parameters
{ "result_code":1, "result_description":"Operation successful", "result_content":[ { "entity_id":"8a1a84550462-40bc9afc-3770-16ac-cd6c", "product":"SLF_PRODUCT_OFFICESCAN_CE", "managing_server_id": "026332F39EBC-41C19604-02DD-2C5F-EDE5", "ad_domain":"", "folder_path":"Workgroup", "ip_address_list":"192.168.121.132", "mac_address_list":"00-0C-29-9B-AB-65", "host_name":"OSCECLIENT", "isolation_status":"normal", "capabilities":[ "cmd_uninstall_agent", "cmd_relocate_agent", "cmd_isolate_agent", "cmd_restore_isolated_agent" ] } ] }
The following table describes the available parameters for the result_content list.
Parameter |
Type |
Description |
---|---|---|
entity_id |
String |
The GUID of the managed product agent |
product |
String |
The Trend Micro product that the agent is for For available values, see Automation API Product Values. |
managing_server_id |
String |
The GUID of the product server that manages the agent |
ad_domain |
String |
The Active Directory domain that the agent belongs to (if applicable) |
folder_path |
String |
The folder path of where the agent is located ont the managing server (for example, the OfficeScan domain that the agent is listed under) |
ip_address_list |
String |
Lists the IP addresses on the agent endpoint |
mac_address_list |
String |
Lists the MAC addresses on the agent endpoint |
host_name |
String |
The endpoint name of the managed product agent |
isolation_status |
String |
Indicates the agent isolation status (if applicable). For available values, see Automation API Isolation Statuses. |
capabilities |
String |
Lists the API actions that can be performed on the agent For available values, see Automation API Actions/Capabilities. |