Get Alarm Types As Key Value - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Get Alarm Types As Key Value","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":["Monitoring - Alarms Details"],"description":"Get alarm types.","operationId":"getAlarmTypesAsKeyValue","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","example":"system"},"value":{"type":"string","example":"System"}},"$$ref":"#/components/schemas/SimpleKeyValueMapping"},"examples":{"Response":{"description":"Response","value":{"header":{"generatedOn":1717666137603},"data":[{"key":"BFD_Node_Up","value":"BFD Node Up"},{"key":"BFD_TLOC_Up","value":"BFD TLOC Up"},{"key":"BFD_TLOC_Down","value":"BFD TLOC Down"},{"key":"BFD_Site_Down","value":"BFD Site Down"},{"key":"BFD_Site_Up","value":"BFD Site Up"},{"key":"BFD_Node_Down","value":"BFD Node Down"},{"key":"Control_Vsmart_Down","value":"Control Vsmart Down"},{"key":"Control_Vsmart_Up","value":"Control Vsmart Up"},{"key":"Control_Site_Down","value":"Control Site Down"},{"key":"Control_TLOC_Down","value":"Control TLOC Down"},{"key":"Control_Vmanage_Up","value":"Control Vmanage Up"},{"key":"Control_Site_Up","value":"Control Site Up"},{"key":"Control_Vmanage_Down","value":"Control Vmanage Down"},{"key":"Control_Vsmarts_Up","value":"Control Vsmarts Up"},{"key":"Control_Node_Up","value":"Control Node Up"},{"key":"Control_TLOC_Up","value":"Control TLOC Up"},{"key":"Control_Node_Down","value":"Control Node Down"},{"key":"Control_All_Vsmarts_Down","value":"Control All Vsmarts Down"},{"key":"OMP_Site_Down","value":"OMP Site Down"},{"key":"OMP_Node_Down","value":"OMP Node Down"},{"key":"OMP_Vsmarts_Up","value":"OMP Vsmarts Up"},{"key":"OMP_All_Vsmarts_Down","value":"OMP All Vsmarts Down"},{"key":"OMP_Vsmart_Down","value":"OMP Vsmart Down"},{"key":"OMP_Site_Up","value":"OMP Site Up"},{"key":"OMP_Node_Up","value":"OMP Node Up"},{"key":"OMP_Vsmart_Up","value":"OMP Vsmart Up"},{"key":"BGP_Router_Down","value":"BGP Router Down"},{"key":"BGP_Router_Up","value":"BGP Router Up"},{"key":"OSPF_Router_Down","value":"OSPF Router Down"},{"key":"OSPF_Router_Up","value":"OSPF Router Up"},{"key":"Device Activation Failed","value":"Device Activation Failed"},{"key":"Container activate failed","value":"Container activate failed"},{"key":"Nat_Update","value":"Nat Update"},{"key":"Tracker_State_Change","value":"Tracker State Change"},{"key":"SD-AVC Cloud Connector Credentials Error","value":"SD-AVC Cloud Connector Credentials Error"},{"key":"BGP_Peer_State_Change","value":"BGP Peer State Change"},{"key":"UTD_File_Reputation_Alert","value":"UTD File Reputation Alert"},{"key":"Container App installation failed","value":"Container App installation failed"},{"key":"ZTP Upgrade Failed","value":"ZTP Upgrade Failed"},{"key":"vManage_Self_Signed_Cert_Out_Of_Sync","value":"vManage Self Signed Cert Out Of Sync"},{"key":"Certificate_Expiration_Status","value":"Certificate Expiration Status"},{"key":"devices-have-no-license-associated","value":"devices-have-no-license-associated"},{"key":"UTD_File_Analysis_Upload_Status","value":"UTD File Analysis Upload Status"},{"key":"ZBFW_Session_Rate_Alert_On","value":"ZBFW Session Rate Alert On"},{"key":"PxGrid_Connection_Notification","value":"PxGrid Connection Notification"},{"key":"OMP_State_Change","value":"OMP State Change"},{"key":"Pseudo_Commit_Status","value":"Pseudo Commit Status"},{"key":"","value":""},{"key":"ZBFW_Session_Rate_Alert_Off","value":"ZBFW Session Rate Alert Off"},{"key":"UTD_Notification","value":"UTD Notification"},{"key":"SLA_Violation_Packet_Drop","value":"SLA Violation Packet Drop"},{"key":"Multicloud","value":"Multicloud"},{"key":"","value":""},{"key":"SLA_Violation","value":"SLA Violation"},{"key":"","value":""},{"key":"Security_Certificate_Expired","value":"Security Certificate Expired"},{"key":"System_License_Mismatch","value":"System License Mismatch"},{"key":"DHCP_Server_State_Change","value":"DHCP Server State Change"},{"key":"Certificate_CRL_Has_Been_Disabled","value":"Certificate CRL Has Been Disabled"},{"key":"Clear_Installed_Certificate","value":"Clear Installed Certificate"},{"key":"Domain-ID_Change","value":"Domain-ID Change"},{"key":"Cisco Secure Access","value":"Cisco Secure Access"},{"key":"New_CSR_Generated","value":"New CSR Generated"},{"key":"UTD_File_Reputation_Retrospective_Alert","value":"UTD File Reputation Retrospective Alert"},{"key":"MultiCloud_License_State_Change","value":"MultiCloud License State Change"},{"key":"Interface_State_Change","value":"Interface State Change"},{"key":"Root_Cert_Chain_Uninstalled","value":"Root Cert Chain Uninstalled"},{"key":"Device Upgrade Failed","value":"Device Upgrade Failed"},{"key":"Umbrella CA has been updated","value":"Umbrella CA has been updated"},{"key":"Template_Rollback","value":"Template Rollback"},{"key":"aaa_Admin_Password_Change","value":"aaa Admin Password Change"},{"key":"UTD signature package installation failed","value":"UTD signature package installation failed"},{"key":"Container reload failed","value":"Container reload failed"},{"key":"CRL_UNREACHABLE_OR_INVALID","value":"CRL UNREACHABLE OR INVALID"},{"key":"APPQOE_ALARM","value":"APPQOE ALARM"},{"key":"Cloud On Ramp","value":"Cloud On Ramp"},{"key":"Disk_Write_Speed","value":"Disk Write Speed"},{"key":"System-IP_Change","value":"System-IP Change"},{"key":"Disaster_Recovery","value":"Disaster Recovery"},{"key":"ZBFW_Session_Maximum","value":"ZBFW Session Maximum"},{"key":"","value":""},{"key":"Certificate_Has_Been_Revoked","value":"Certificate Has Been Revoked"},{"key":"Memory_Usage","value":"Memory Usage"},{"key":"UTD_File_Analysis_Status_Event","value":"UTD File Analysis Status Event"},{"key":"vSmart/vManage_Serial_File_Uploaded","value":"vSmart/vManage Serial File Uploaded"},{"key":"Edge_Device_Has_Been_Quarantined","value":"Edge Device Has Been Quarantined"},{"key":"Process_Restart","value":"Process Restart"},{"key":"Zscaler SSE Sublocation","value":"Zscaler SSE Sublocation"},{"key":"UTD_Version_Mismatch","value":"UTD Version Mismatch"},{"key":"OSPF_Neighbor_State_Change","value":"OSPF Neighbor State Change"},{"key":"Acknowledgement file not uploaded","value":"Acknowledgement file not uploaded"},{"key":"UTD_File_Reputation_Status_Event","value":"UTD File Reputation Status Event"},{"key":"AppQoe site id mismatch","value":"AppQoe site id mismatch"},{"key":"failed to update umbrella CA","value":"failed to update umbrella CA"},{"key":"Interface_Admin_State_Change","value":"Interface Admin State Change"},{"key":"CPU_Usage","value":"CPU Usage"},{"key":"UTD_Con","value":"UTD Con"},{"key":"Interface_State_Change","value":"Interface State Change"},{"key":"Control_No_Active_vBond","value":"Control No Active vBond"},{"key":"Geo_Fence_Alert_Status","value":"Geo Fence Alert Status"},{"key":"OMP_Ribout_Gen_Failure","value":"OMP Ribout Gen Failure"},{"key":"UTD_IPS_Alert","value":"UTD IPS Alert"},{"key":"Container reset failed","value":"Container reset failed"},{"key":"System_IP_Reuse","value":"System IP Reuse"},{"key":"API_VOLUME_MONITOR","value":"API VOLUME MONITOR"},{"key":"Vmanage_Service_State","value":"Vmanage Service State"},{"key":"WebServer_Certificate_Warning","value":"WebServer Certificate Warning"},{"key":"Default App List Update","value":"Default App List Update"},{"key":"edge device doesn't support umbrella CA update","value":"edge device doesn't support umbrella CA update"},{"key":"AAA_Password_Expiry_Warning","value":"AAA Password Expiry Warning"},{"key":"Root_Cert_Chain_Installed","value":"Root Cert Chain Installed"},{"key":"Site-ID_Change","value":"Site-ID Change"},{"key":"Disk_Read_Speed","value":"Disk Read Speed"},{"key":"Pim_Interface_State_Change","value":"Pim Interface State Change"},{"key":"License report generation failure","value":"License report generation failure"},{"key":"vEdge_Serial_File_Uploaded","value":"vEdge Serial File Uploaded"},{"key":"ROOTCA_SYNC_FAILURE","value":"ROOTCA SYNC FAILURE"},{"key":"Data_Policy_Commit_Failure","value":"Data Policy Commit Failure"},{"key":"Security_Certificate_Expiring","value":"Security Certificate Expiring"},{"key":"","value":""},{"key":"AAA_Password_Expired","value":"AAA Password Expired"},{"key":"Vmanage_Critical_Space_Usage","value":"Vmanage Critical Space Usage"},{"key":"ZBFW_Half_Open_Limit_Hit","value":"ZBFW Half Open Limit Hit"},{"key":"HTTP_PROXY_UNREACHABLE","value":"HTTP PROXY UNREACHABLE"},{"key":"CRL_Has_Been_Disabled","value":"CRL Has Been Disabled"},{"key":"System_Reboot_Issued","value":"System Reboot Issued"},{"key":"Container upgrade failed","value":"Container upgrade failed"},{"key":"Analytics-license-compliance","value":"Analytics-license-compliance"},{"key":"","value":""},{"key":"Disk_Usage","value":"Disk Usage"},{"key":"Control_vBond_State_Change","value":"Control vBond State Change"},{"key":"UTD_Update","value":"UTD Update"},{"key":"vManage_Queue_State","value":"vManage Queue State"},{"key":"Cloned_Vedge_Detected","value":"Cloned Vedge Detected"},{"key":"AppQoe service node state","value":"AppQoe service node state"},{"key":"Org_Name_Change","value":"Org Name Change"},{"key":"Vmanage_Node_Reachability_State","value":"Vmanage Node Reachability State"},{"key":"CRL_Has_Been_Enabled","value":"CRL Has Been Enabled"},{"key":"Unsupported_SFP_Detected","value":"Unsupported SFP Detected"},{"key":"SSL_Certificate_Warning","value":"SSL Certificate Warning"}]},"$$ref":"#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseRulenamedisplayKeyvalue"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read","method":"get","path":"/alarms/rulenamedisplay/keyvalue"}}