Page tree




In This Document 


Was this document useful? 
Your Rating:
Results:
1 Star2 Star3 Star4 Star5 Star
2 rates


Have a suggestion for the Armor Knowledge Base? Send a message to kb@armor.com.



Overview

This API call applies to both Armor Complete and Armor Anywhere users.

The Get Overview Security Status API retrieves the various statuses of your virtual machines's subcomponents (Anti-Malware, FIM, and OS Patching).  


Sample request

GET https://api.armor.com/core/security-dashboard/stats/overview

Input

The following table describes the different parts of this API call: 

API Call / URLMethod / Type
/core/security-dashboard/stats/overviewGET

There are no parameters for this API call. 


Sample return

With AMP 2.61, the following returns will contain a null response:

  • osPatchingOkStatus 
  • osPatchingWarningStatus 
  • osPatchingCriticalStatus 
StatusResponse
200
{
   "avamOkStatus": 4,
   "avamWarningStatus": 0,
   "avamCriticalStatus": 1,
   "fimOkStatus": 5,
   "fimWarningStatus": 0,
   "fimCriticalStatus": 0,
   "osPatchingOkStatus": null,
   "osPatchingWarningStatus": null,
   "osPatchingCriticalStatus": null,
   "overAllOkStatus": 4,
   "overAllWarningStatus": 0,
   "overAllCriticalStatus": 1
}