{"type":"api","title":"Get Alarm Notification Policy","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/9792902d-b2cb-3a50-8089-29b3532bc5ed","info":{"title":"Crosswork Alarms and Events APIs","description":"Crosswork Alarms and Events APIs allow applications to create, update, acknowledge and clear alarms.","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"},"version":"7.1.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/FAULT_MANAGEMENT/fault-infra-api-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{server_ip}:30603/crosswork/alarm/v1","description":"Alarm/Alarm-Rest"}]},"spec":{"tags":["Alarm-Rest"],"summary":"Get Alarm Notification Policy","operationId":"getANP","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"Get Policy","properties":{"groupName":{"type":"string","description":"The name of the group for the policy"},"description":{"type":"string","description":"A description of the policy"},"alarmType":{"title":"Alarm Type can be System/Network or Device","type":"string","enum":["System/Network","Device"],"example":"System/Network","description":"The type of alarm for the policy"},"criteria":{"type":"string","description":"The criteria for the policy"},"deviceGroups":{"uniqueItems":true,"type":"array","items":{"type":"string"},"description":"A list of device groups associated with the policy"},"editable":{"type":"string","description":"Whether the policy is editable"},"lastUpdateTime":{"type":"string","description":"The timestamp when the policy was last updated"},"trapDestinations":{"type":"array","items":{"type":"object","description":"Get Trap Destination","properties":{"name":{"type":"string","description":"The name of the trap destination"}},"$$ref":"#/components/schemas/TrapDestinationGet"},"description":"A list of trap destinations for the policy"},"syslogDestinations":{"type":"array","items":{"type":"object","description":"Get Syslog Destination","properties":{"name":{"type":"string","description":"The name of the syslog destination"},"port":{"type":"integer","format":"int32","description":"The port number used for syslog communications"},"secure":{"type":"boolean","default":false,"description":"Whether the syslog communication is secure"}},"$$ref":"#/components/schemas/SyslogDestinationGet"},"description":"A list of syslog destinations for the policy"},"kafkaDestinations":{"type":"array","items":{"type":"object","description":"Get Kafka Destination","properties":{"name":{"type":"string","description":"The name of the Kafka destination"}},"$$ref":"#/components/schemas/KafkaDestinationGet"},"description":"A list of Kafka destinations for the policy"},"restconfDestinations":{"type":"array","items":{"type":"object","description":"Get RESTConf Destination","properties":{"name":{"type":"string","description":"The name of the RESTConf destination"},"usergroups":{"type":"string","description":"The user groups associated with the RESTConf destination"}},"$$ref":"#/components/schemas/RestConfDestinationGet"},"description":"A list of RESTConf destinations for the policy"}},"$$ref":"#/components/schemas/PolicyGet"},"example":{"data":[{"groupName":"ANPTest","description":"ANP description","alarmType":"System/Network","criteria":"*","lastUpdateTime":"2025-01-07T17:39:49.972+00:00","editable":true,"trapDestinations":[{"name":"testtrap"}],"syslogDestinations":[{"name":"TestSyslogServer","action":"create","host":"1.2.3.4","port":514,"certificate_id":"certificateid","secure":true}],"restconfDestinations":[{"name":"restDestinaton","action":"create","usergroups":"testgroup"}],"kafkaDestinations":[{"name":"ext.kaf.topic.alarm","action":"create"}]}]}}}},"403":{"description":"Authentication and Authorization errors"},"500":{"description":"operation-failed Response with error"}},"__originalOperationId":"getANP","method":"get","path":"/notificationpolicy"}}