Retrieves device protection status.
Retrieves a list of devices with their protection status and other device information. The response to this request is limited to 3,000 records.
get/api/v1/accounts/{accountId}/devicesprotectionstatus
Request
- Base URLhttps://api.usa.cloud.watchguard.com/rest/aether-endpoint-security/aether-mgmt
- AuthAPI key in header WatchGuard-API-Key and HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
accountIdstring required
Your WatchGuard Cloud account ID.
Query parameters
topinteger
Specifies the number of objects to retrieve (there is a maximum supported by the server).
skipinteger
Bypasses the specified number of objects in the results returned.
searchstring
Returns only objects that include the specified text string.
countboolean
Indicates whether to return a counter that shows the total number of objects in the total_items response parameter.
orderbystring
Specifies how to order results. You can order by any parameter in the response and sort results in ascending or descending order.
Response
OK
Example response
[
{
"data": {
"host_name": "WIN_SERVER_6",
"device_id": "123456d8-910f-4f5a-a7ad-e2480d5ad1b2",
"device_type": 1,
"accumulated_protection_status": 2,
"adaptive_defense_status": 2,
"file_antivirus_status": 2,
"firewall_status": 2,
"isolation_state": 1,
"protection_engine_update_status": 2,
"protection_engine_version": "1.17.00.0000",
"knowledge_catalog_update_status": 2,
"knowledge_catalog_date": "2020-09-22T11:00:00Z",
"last_connection_date": "2020-09-22T11:00:00Z",
"reboot_requested": true,
"reinstall_protection_requested": true,
"reinstall_agent_requested": true,
"reinstall_agent_error": {
"error": 58,
"code": 2020,
"date_time": "2020-11-20T20:27:18.725Z",
"step": 2
},
"reinstall_protection_error": {
"error": 36,
"code": 4001,
"date_time": "2020-11-20T20:27:18.725Z",
"step": 8
}
}
}
]Changes
No recorded changes to this operation across all 1 revision of this API.