{"type":"api","title":"Create Alarm List","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/d2f02ba2-fd0d-3a26-bcc5-feafc8f24d17","info":{"title":"Monitoring and Troubleshooting","description":"Includes API operations for the following:\n- Real-time monitoring\n- Accessing statistics APIs and statistics bulk APIs\n- Retrieving device state\n- Managing alarms and events\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Real-Time Monitoring - Hardware"],"description":"Get hardware alarm list from device","operationId":"createAlarmList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Hardware alarm list":{"description":"Hardware alarm list","value":{"data":[{"alarm-time":"2022-04-26T02:28:26+00:00","vdevice-dataKey":"10.0.0.121-22-0","vdevice-name":"10.0.0.121","alarm-id":"22","alarm-description":"PowerSupply/FANModuleMissing","lastupdated":1652171693495,"alarm-instance":"0","alarm-category":"alarm-severity-critical","vdevice-host-name":"Router","alarm-name":"PowerSupplyBay1"},{"alarm-time":"2022-04-26T02:28:26+00:00","vdevice-dataKey":"10.0.0.121-62-0","vdevice-name":"10.0.0.121","alarm-id":"62","alarm-description":"PowerOverEthernetModuleMissing","lastupdated":1652171693495,"alarm-instance":"0","alarm-category":"alarm-severity-info","vdevice-host-name":"Router","alarm-name":"POEBay0"},{"alarm-time":"2022-04-26T02:28:26+00:00","vdevice-dataKey":"10.0.0.121-82-0","vdevice-name":"10.0.0.121","alarm-id":"82","alarm-description":"PowerOverEthernetModuleMissing","lastupdated":1652171693495,"alarm-instance":"0","alarm-category":"alarm-severity-info","vdevice-host-name":"Router","alarm-name":"POEBay1"},{"alarm-time":"2022-04-26T02:29:44+00:00","vdevice-dataKey":"10.0.0.121-1090-1","vdevice-name":"10.0.0.121","alarm-id":"1090","alarm-description":"TransceiverMissing-LinkDown","lastupdated":1652171693495,"alarm-instance":"1","alarm-category":"alarm-severity-info","vdevice-host-name":"Router","alarm-name":"subslot0/0transceivercontainer0"},{"alarm-time":"2022-04-26T02:29:44+00:00","vdevice-dataKey":"10.0.0.121-1100-1","vdevice-name":"10.0.0.121","alarm-id":"1100","alarm-description":"TransceiverMissing-LinkDown","lastupdated":1652171693495,"alarm-instance":"1","alarm-category":"alarm-severity-info","vdevice-host-name":"Router","alarm-name":"subslot0/0transceivercontainer1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write","method":"get","path":"/device/hardware/alarms"}}