{"type":"api","title":"Edit Alarm Policy","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/3ba2ebf1-2c82-351f-9129-0701a2a03db6","info":{"title":"APIs exposed by Alarm Rest service","description":"APIs exposed by Alarm Rest service.","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"7.1.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/fault-emf-api-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{server_ip}:30603/crosswork/alarm/v1","description":"Generated server url"}]},"spec":{"tags":["alarm-rest"],"summary":"Edit Alarm Policy","description":"Supported Actions : Edit Alarm Suppression policy\n\nPayload attributes: \n\u003cb\u003epolicyname\u003c/b\u003e: string (policy Name) \n\u003cb\u003edescription\u003c/b\u003e: string (Policy Description) \n\u003cb\u003eaction\u003c/b\u003e: string ('suppressAlarm' - Suppression of Alarm only or 'suppressEvent' - Suppression of Alarm and Event) \n\u003cb\u003edeviceGroups\u003c/b\u003e: string (for example '53b897fd-0801-4f03-a895-0c968da2c127' ) \n\u003cb\u003ecriteria\u003c/b\u003e: string (for example eventType in ['L2-BFD-6-SESSION_NO_RESOURCES','ROUTING-MPLS_TE-5-S2L_BFD_DOWN'])","operationId":"updateAlarmPolicy","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Configuration for an alarm policy","properties":{"policyname":{"type":"string","description":"Name of the policy"},"description":{"type":"string","description":"Description of the policy"},"action":{"type":"string","description":"Action type for the policy","example":"suppressAlarm/suppressEvent"},"deviceGroups":{"type":"array","description":"List of device groups associated with the policy","uniqueItems":true,"items":{"type":"string"}},"criteria":{"type":"string","description":"Criteria for the policy, such as event types","example":"eventType in [comma separated eventtypes]"}},"$$ref":"#/components/schemas/AlarmPolicy"},"example":{"policyname":"TestPolicy","description":"Policy Description","action":"suppressAlarm","deviceGroups":["456cdc5b-0b45-4252-b2be-18226e599028"],"criteria":"eventType in [ROUTING-MPLS_TE-5-S2L_BFD_DOWN]"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"Response object for alarm policy operations","properties":{"message":{"type":"string","description":"Message indicating the result of the operation"},"status":{"type":"string","description":"Status of the operation"}},"$$ref":"#/components/schemas/AlarmPolicyResponse"},"example":{"message":"Success","status":"Success"}}}},"403":{"description":"Authentication and Authorization errors"},"500":{"description":"operation-failed Response with error"}},"__originalOperationId":"updateAlarmPolicy","method":"put","path":"/suppressionpolicy"}}