OrgsAlarm Templates
updateOrgAlarmTemplate
Update an organization alarm template's default delivery settings or per-alarm rule overrides.
Authorization<token>
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
org_id*string
Format
uuidalarmtemplate_id*string
Format
uuidRequest Body
application/json
Request Body
Alarm template defining default delivery and per-alarm rules
delivery*
Default alarm delivery settings for rules in this template
name?string
Some string to name the alarm template
rules*
Alarm Rules object to configure the individual alarm keys/types. Property key is the alarm name.
Response Body
curl -X PUT "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/alarmtemplates/000000ab-00ab-00ab-00ab-0000000000ab" \ -H "Content-Type: application/json" \ -d '{ "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "name": "string", "rules": { "adhoc_network": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "air_magnet_scan": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "ap_offline": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "bad_cable": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "beacon_flood": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "bssid_spoofing": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "device_down": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "device_restarted": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "dhcp_failure": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "disassociation_flood": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "dot1x_failure": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "eap_dictionary_attack": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "eap_failure_injection": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "eap_handshake_flood": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "eap_spoofed_success": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "eapol_logoff_attack": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "essid_jack": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "excessive_client": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "excessive_eapol_start": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "gateway_down": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "gw_bad_cable": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "gw_negotiation_mismatch": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "honeypot_ssid": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "krack_attack": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "missing_vlan": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "monkey_jack": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "negotiation_mismatch": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "non_compliant": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "out_of_sequence": { "enabled": true }, "psk_failure": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "repeated_auth_failures": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "rogue_ap": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "rogue_client": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "secpolicy_violation": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "ssid_injection": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "switch_down": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "tkip_icv_attack": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "vendor_ie_missing": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "watched_station": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "zero_ssid_association": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true } } }'{ "created_time": 0.1, "delivery": { "additional_emails": [ "john@mycorp.com" ], "enabled": true, "to_org_admins": true, "to_site_admins": false }, "id": "53f10664-3ce8-4c27-b382-0ef66432349f", "modified_time": 0.1, "name": "default", "org_id": "a97c1b22-a4e9-411e-9bfd-d8695a0f9e61", "rules": { "ap_offline": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "bad_cable": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true } }}