How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cisco Catalyst SD-WAN Monitoring - Alarms Details API

The Monitoring - Alarms Details API from Cisco Catalyst SD-WAN — 29 operation(s) for monitoring - alarms details.

Cisco Catalyst SD-WAN Monitoring - Alarms Details API is one of 382 APIs that Cisco Catalyst SD-WAN publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Monitoring - Alarms Details. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 36 operations across 29 paths. It is described by OpenAPI 3.2.0, at version 26.1.0+2026-01-06.

Requests are made against a single base URL, /dataservice.

36 operations 29 paths 0 schemas 22 GET14 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
26.1.0+2026-01-06
Base URL
https://{sdwan-manager-host}:8443/dataservice
Resource Areas
1

Paths & Operations 36

Across 29 paths, the API surfaces 36 operations — 22 GET, 14 POST. Each is listed below with its method, path, parameters, and response codes.

Monitoring - Alarms Details 36
POST
/alarms
Get alarms for given query.
postRawAlarmData 6 params body → 200400403500
GET
/alarms
Get alarms for given query. If query is empty then last 30 mins data will be returned.
getRawAlarmData 3 params → 200400403500
GET
/alarms/aggregation
Get aggregated count of alarms based on given query.
getAggregationData_MonitoringAlarmsDetails_1903 3 params → 200400403500
POST
/alarms/aggregation
Get aggregated count of alarms based on given query.
postAggregationData_MonitoringAlarmsDetails_1904 2 params body → 200400403500
POST
/alarms/clear
Clear the alarm for a specific UUID.
clearStaleAlarm body → 200400403500
POST
/alarms/count
Get the count of alarms as per the query passed.
postCount 2 params body → 200400403500
GET
/alarms/count
Get the count of alarms which are active and not acknowledged by user.
getNonViewedActiveAlarmsCount 1 param → 200400403500
POST
/alarms/disabled
Enable/Disable alarms by event name
disableEnableAlarm 3 params → 200400403500
GET
/alarms/disabled
List all disabled alarms
listDisabledAlarm → 200400403500
GET
/alarms/doccount
Get the count of alarms as per the query passed.
getDocCount_MonitoringAlarmsDetails_1603 2 params → 200400403500
POST
/alarms/doccount
Get the count of alarms as per the query passed.
postDocCount_MonitoringAlarmsDetails_1604 1 param body → 200400403500
POST
/alarms/dump
Dump correlation engine server cache in log file
dumpCorrelationEngineData → 200400403500
GET
/alarms/fields
Get fields and types
getAlarmDataFields → 200400403500
GET
/alarms/link-state-alarm
Get configuration for link-state alarm
getLinkStateAlarmConfig → 200400403500
POST
/alarms/link-state-alarm
Enable/Disable a specific link-state alarm
enableDisableLinkStateAlarm 2 params → 200400403500
POST
/alarms/markallasviewed
Mark all alarms as acknowledged by the user
markAllAlarmsAsViewed 1 param body → 200400403500
POST
/alarms/markviewed
Mark alarms as acknowledged based on list of UUIDs.
markAlarmsAsViewed body → 200400403500
GET
/alarms/master
Get topic details.
getLeaderManagerState → 200400403500
GET
/alarms/notviewed
Get alarms which are not acknowledged by the user.
getNonViewedAlarms 1 param → 200400403500
GET
/alarms/page
Get paginated alarms
getPage_MonitoringAlarmsDetails_1203 4 params → 200400403500
POST
/alarms/page
Get paginated alarm raw data
postPage_MonitoringAlarmsDetails_1204 3 params body → 200400403500
GET
/alarms/purgefrequency
Set alarm purge timer
setPeriodicPurgeTimer 2 params → 200400403500
GET
/alarms/query/fields
Get query fields
getAlarmQueryFields → 200400403500
GET
/alarms/query/input
Get alarm field details
getFieldDetails → 200400403500
GET
/alarms/reset
Reset correlation engine.
reset → 200400403500
GET
/alarms/restart
Restart correlation engine.
restartCorrelationEngine → 200400403500
GET
/alarms/rulenamedisplay/keyvalue
Get alarm types.
getAlarmTypesAsKeyValue → 200400403500
GET
/alarms/severity
Get alarms by severity
getBySeverity 4 params → 200400403500
GET
/alarms/severity/summary
Get alarm severity histogram
getAlarmSeverityCustomHistogram 2 params → 200400403500
GET
/alarms/severitymappings
Gets alarm severity mappings
getAlarmSeverityMappings → 200400403500
POST
/alarms/starttracking/{testName}
Start tracking events
startTracking 1 param → 200400403500
GET
/alarms/stats
Get alarm statistics
getStats → 200400403500
POST
/alarms/stoptracking/{testName}
Stop tracking events
stopTracking 1 param → 200400403500
GET
/alarms/topic
Get topic on which alarms for given device are publishing.
getDeviceTopic 1 param → 200400403500
POST
/alarms/topn
Returns top-n alarm count based on given query
getTopN 2 params body → 200400403500
GET
/alarms/uuid/{alarm_uuid}
Get alarm details for given UUID
getAlarmDetails 2 params → 200400403500

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cisco-catalyst-sdwan-monitoring-alarms-details-api-openapi.yml Raw ↑

Other APIs Cisco Catalyst SD-WAN publishes across the network.

Cisco Catalyst SD-WAN Administration - Audit Log API
Cisco Catalyst SD-WAN Administration - User and Group API
Cisco Catalyst SD-WAN CCI Authorization Service - CCI Registration API
Cisco Catalyst SD-WAN CCI Authorization Service - CCI Token API
Cisco Catalyst SD-WAN Certificate Management - Device API
Cisco Catalyst SD-WAN Certificate Management - vManage API
Cisco Catalyst SD-WAN Cisco Software API
Cisco Catalyst SD-WAN Client - Security API
Cisco Catalyst SD-WAN Client - UI API
Cisco Catalyst SD-WAN Cloud Sourced Application Compliance API
Cisco Catalyst SD-WAN Cloud Sourced Application Maintenance API
Cisco Catalyst SD-WAN Cluster Management API
Where this information came from

This is an independent, third-party profile of Cisco Catalyst SD-WAN Monitoring - Alarms Details API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.