Expose Policy/Automation Action Name in Alarm Record API Response

Products

• DX SaaS

Issue/Introduction

We are using DX Operational Intelligence SaaS and have built a custom NOC dashboard that consumes alarm data via the /oi/v2/api/consolidated_alarms/_search API endpoint.

We have approximately 36 automation policies configured in DX OI (Settings → Policies) that handle alarm routing, ticketing, and notifications. When an alarm is processed and the actionStatus field returns SUCCESS, we would like to know which specific policy was applied to that alarm.

Current behavior: The alarm API response includes actionStatus: "SUCCESS" but does not include the policy name or policy ID that executed the action.

We would like to expose the policy name and/or policy ID that fired on each alarm in the API response payload, either as a new field (e.g. policyName, policyId) or within the existing alarm record.

Use case: Our NOC team needs to quickly identify which policy handled a specific alarm so they can make adjustments to policy thresholds and routing rules without having to manually cross-reference 36 policies against each alarm type.

 

Resolution

(1) numeric alarmIds returning empty results, and 

--Seems your Alarms with numeric alarmIds are Situation Alarm, so you need to set parameter lifeCycleType

 

(2) supported pagination parameters for the lifecycle endpoint

--Please refer to the sample below:

{

  "alarmId": "<situation-cluster-alarm-unique-id>",

  "lifeCycleType": "SITUATION",

  "pageNumber": "0",

  "pageSize": "10",

  "sortCol": "timestamp:desc"

}

After implementing the above for numeric alarmIds it was confirmed that Lifecycle Events are now populating correctly for all alarms in the dashboard.