Skip to main content

GET /events/monitors?format=currentFormat&id={monitor_id}

Use this method to return the current format of the output for a specific event forwarder.

For the format of the email subject for a specific event forwarder for a email service, see GET /events/monitors?format=currentSubjectFormat&id={monitor_id}.

Authentication​

Authentication with username and password is required.

Request URL​

GET https://{management_server_IP}/events/monitors?format=currentFormat&id={monitor_id}

where {monitor_id} is the ID of the event forwarder. To obtain the filter ID, use the GET /events/monitors method.

Query parameters​

None

Request body​

None

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
401UnauthorizedThe user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

AttributesTypeDescription
{monitor_id}StringList of attributes (format keys) in the output format of the specified event forwarder

Text between double square brackets are the attributes that which are replaced with actual values. For a description of each attribute, use GET /events/monitors?format=formatKeys.

The following example is returned if the request is successful for an event forwarder to a email service.

{
   "1507301877371": "Alert: [[EventDate]] [[EventMessage]]\n
                     \n
                     Hardware Information:\n 
                      Managed Endpoint    : [[DeviceHardwareType]] at [[DeviceIPAddress]]\n 
                      Device name         : [[DeviceName]]\n 
                      Product name        : [[DeviceProductName]]\n 
                      Host name           : [[DeviceHostName]]\n 
                      Machine Type        : [[DeviceMachineType]]\n 
                      Machine Model       : [[DeviceMachineModel]]\n 
                      Serial Number       : [[DeviceSerialNumber]]\n 
                      DeviceHealthStatus  : [[DeviceHealthStatus]]\n 
                      IPv4 addresses      : [[DeviceIPV4Addresses]]\n 
                      IPv6 addresses      : [[DeviceIPV6Addresses]]\n 
                      Chassis             : [[DeviceChassisName]]\n 
                      DeviceBays          : [[DeviceBays]]\n
                     \n
                     LXCA is: [[ManagementServerIP]]\n
                     \n
                     Event Information:\n  
                       Event ID        : [[EventID]]\n  
                       Common Event ID : [[CommonEventID]]\n  
                       EventSeverity   : [[EventSeverity]]\n  
                       Event Class     : [[EventClass]]\n  
                       Sequence ID     : [[EventSequenceID]]\n  
                       Event Source ID : [[EventSourceUUID]]\n  
                       Component ID    : [[EventComponentUUID]]\n  
                       Serial Num      : [[EventSerialNumber]]\n  
                       MTM             : [[EventMachineTypeModel]]\n  
                       EventServices   : [[EventServices]]\n  
                       Console link    : [[ConsoleLink]]\n  
                       iOS link        : [[iOSLink]]\n  
                       Android link    : [[AndroidLink]]\n  
                       System Name     : [[DeviceFullPathName]]\n"
}