{ "opencollection": "1.0.0", "info": { "name": "Mist Admins Orgs Alarms API", "version": "2604.1.1" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Orgs Alarms", "type": "folder" }, "items": [ { "info": { "name": "ackOrgMultipleAlarms", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/orgs/:org_id/alarms/ack", "params": [ { "name": "org_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Ack multiple Org Alarms" }, { "info": { "name": "ackOrgAllAlarms", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/orgs/:org_id/alarms/ack_all", "params": [ { "name": "org_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Ack all Org Alarms\n\n**N.B.**: Batch size for multiple alarm ack and unack has to be less or or equal to 1000." }, { "info": { "name": "countOrgAlarms", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/orgs/:org_id/alarms/count", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "distinct", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query", "description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")" }, { "name": "end", "value": "", "type": "query", "description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")" }, { "name": "duration", "value": "", "type": "query", "description": "Duration like 7d, 2w" }, { "name": "limit", "value": "", "type": "query" } ] }, "docs": "Count by Distinct Attributes of Org Alarms" }, { "info": { "name": "searchOrgAlarms", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/orgs/:org_id/alarms/search", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "site_id", "value": "", "type": "query", "description": "Site ID" }, { "name": "group", "value": "", "type": "query", "description": "Alarm group. enum: `infrastructure`, `marvis`, `security`. \nThe `marvis` group is used to retrieve AI-driven network issue detections. \nKnown Marvis alarm types include: `bad_cable`, `bad_wan_uplink`, `dns_failure`, \n`arp_failure`, `auth_failure`, `dhcp_failure`, `missing_vlan`, \n`negotiation_mismatch`, `port_flap`. Results include resolution status \n(`status`, `resolved_time`) and affected entity details.\"" }, { "name": "severity", "value": "", "type": "query", "description": "Severity of the alarm. enum: `critical`, `info`, `warn`" }, { "name": "type", "value": "", "type": "query", "description": "Type of the alarm. Accepts multiple values separated by comma. Use [List Alarm Definitions](/#operations/listAlarmDefinitions) to get the list of possible alarm types." }, { "name": "ack_admin_name", "value": "", "type": "query", "description": "Name of the admins who have acked the alarms; accepts multiple values separated by comma" }, { "name": "acked", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query", "description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")" }, { "name": "end", "value": "", "type": "query", "description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")" }, { "name": "duration", "value": "", "type": "query", "description": "Duration like 7d, 2w" }, { "name": "limit", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query", "description": "On which field the list should be sorted, -prefix represents DESC order" }, { "name": "search_after", "value": "", "type": "query", "description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed." } ] }, "docs": "Search Org Alarms" }, { "info": { "name": "unackOrgMultipleAlarms", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/orgs/:org_id/alarms/unack", "params": [ { "name": "org_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Unack multiple Org Alarms" }, { "info": { "name": "unackOrgAllAlarms", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/orgs/:org_id/alarms/unack_all", "params": [ { "name": "org_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Unack all Org Alarms\n\n**N.B.**: Batch size for multiple alarm ack and unack has to be less or or equal to 1000." }, { "info": { "name": "ackOrgAlarm", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/orgs/:org_id/alarms/:alarm_id/ack", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "alarm_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Ack Org Alarm" }, { "info": { "name": "subscribeOrgAlarmsReports", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/orgs/:org_id/subscriptions", "params": [ { "name": "org_id", "value": "", "type": "path" } ] }, "docs": "Subscribe to Org Alarms/Reports\nSubscriptions define how Org Alarms/Reports are delivered to whom" }, { "info": { "name": "unsubscribeOrgAlarmsReports", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mist.com/api/v1/orgs/:org_id/subscriptions", "params": [ { "name": "org_id", "value": "", "type": "path" } ] }, "docs": "Unsubscribe from Org Alarms/Reports\nSubscriptions define how Org Alarms/Reports are delivered to whom" } ] } ], "bundled": true }