Retrieves a list of managed product servers, such as Apex One servers.
HTTP Request
GET /WebApp/API/ServerResource/ProductServers
Parameters
Name |
Type |
Description |
---|---|---|
Optional Parameters |
||
entity_id |
String |
The GUID of the managed product server |
ip_address |
String |
The IP address of the managed product server |
host_name |
String |
The host name of the managed product server |
product |
String |
The Trend Micro product that the server is for For available values, see Automation API Product Values. |
HTTP Request Example
GET /WebApp/API/ServerResource/ProductServers? ip_address=192.168.121.131
HTTP Request Body
Specify a JSON object containing the following:
-
HTTP header:
Field Name
Value
Authorization
Bearer [Generated JWT authentication token]
-
Request body:
[Blank]
Response
If successful, this method returns an HTTP status code of "200" and a response body with a result code of "1" and the following structure:
{ "result_code":1 "result_description":"Operation successful" "result_content":[ { "entity_id":"026332F39EBC-41C19604-02DD-2C5F-EDE5", "product":"SLF_PRODUCT_OFFICESCAN_CE", "ad_domain":"", "ip_address_list": "192.168.121.131,fe80::8846:d1ac:8ee1:85ce", "host_name":"OSCESERVER", "capabilities":[ "cmd_deploy_update_sources" ] } ] }
Where the result_content object contains a list of servers that match all of the specified parameters:
Name |
Type |
Description |
---|---|---|
entity_id |
String |
The GUID of the managed product server |
product |
String |
The Trend Micro product on the server instance For available values, see Automation API Product Values. |
ad_domain |
String |
The Active Directory domain that the server belongs to (if applicable) |
ip_address_list |
String |
The IP address list on the server |
host_name |
String |
The host name of the server |
capabilities |
String |
Lists the API actions that can be performed on the server For available values, see Automation API Actions/Capabilities. |
For more information about API responses and descriptions of response codes, see the following topics: