The endpoints described below allow to get information about the monitored systems as well as generated metrics and alarms.

Note: Those endpoints are only available if the Generic event server plugin is active.

Once the plugin is configured and active, alerts, metrics and monitored infrastructure will be available through the API.

1. Start by discovering the monitored landscapes 
2. Poll regularly alarms and metrics queues. We recommend to poll the queues every minute.
3. Refresh landscape metadata once per hour

• Generated alarms and metrics will correlate with discovered groups, systems and instances.
• For each alarm and metric, three parameters can be used to correlate it to a component of the landscape:
  • The groupUUID parameter will match the UUID of a discovered group.
  • The sid parameter will match the sid of a system
  • The instance parameter will match the name of an instance.

This endpoint will return information about monitored systems, such as properties, instances, types, etc…

• Monitored landscape architecture is not supposed to change very often.
• Therefore it is probably not necessary to poll it more than once every hour.

• The service returns a JSON table of monitored groups, systems and instances
• Groups will contain systems, which will contain instances

Group structure format:

System structure format:

Instance structure format:

This endpoint will return a chunk of generated alarms. To call this endpoint with a POST method will remove alarms from the queue, this is the recommanded way.
You can also call this endpoint with a GET method, this will just list the alarms from the queue. Intended for testing only, as alarms may fill up the queue rather quickly

• It is advised to poll the queue often with small chunks
• We recommend a poll period of 60 sec.
• If the amount of returned alarms is equal to the max size of the chunk, it means that more alarms can be fetched and another call can be triggered.

• The service returns a JSON table of alarms

Alarm structure format:

• (1): Same problem on same resource gets same id.
• (2): If set to true, the severity will represent the last generated one before the alarm was cleared.
• (3): Some problems are events that cannot be “undone”, so the alert will always stay.

Note: Undocumented parameters are not to be used.

Get the number of metrics waiting to be collected from the queue

This endpoint returns a chunk of generated metrics. To collect metrics will remove them from the queue.

• It is advised to poll the queue often with small chunks
• We recommend a poll period of 60 sec.
• If the amount of returned metrics is equal to the max size of the chunk, it means that more metrics can be fetched and another call can be triggered.

• The service returns a JSON table of metrics

Metric structure format:

• (1): Represents the resource being 'measured', by example Disk C:, User X
• (2): For percent, sampleMax is 100. To use only if hasMax is set.

Note: Undocumented parameters are not to be used.