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 Crosswork Alarms API

The Alarms API from Cisco Crosswork — 9 operation(s) for alarms.

Cisco Crosswork Alarms API is one of 99 APIs that Cisco Crosswork publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Alarms. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 11 operations across 9 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version version not set.

Requests are made against the base URL https://{crosswork-host}:{port}.

11 operations 9 paths 14 schemas 2 DELETE6 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
version not set
Base URL
https://{crosswork-host}:{port}
Resource Areas
1

Paths & Operations 11

Across 9 paths, the API surfaces 11 operations — 2 DELETE, 6 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Alarms 11
PUT
/v1/ack
Acknowledge Alarms
AcknowledgeAlarms body → 200
PUT
/v1/clear
Clear alarms
ClearAlarms body → 200
POST
/v1/event
Create and raise an event
RaiseEvent body → 200
PUT
/v1/note
Add Note to Alarms
NoteAlarms body → 200
POST
/v1/query
Get Alarms according to criteria in the request
GetAlarms body → 200
DELETE
/v1/rest-dest
Del Rest Destination
DelRestDestination body → 200
POST
/v1/rest-dest
Add Rest Destination
AddRestDestination body → 200
POST
/v1/rest-dest/query
Get Syslog Destinations, always return a full list
GetRestDestinations body → 200
DELETE
/v1/syslog-dest
Del Syslog Destination
DelSyslogDestination body → 200
POST
/v1/syslog-dest
Add Syslog Destination
AddSyslogDestination body → 200
POST
/v1/syslog-dest/query
Get Syslog Destinations, always return a full list
GetSyslogDestinations body → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are alarmsAlarm (20 properties), alarmsEvent (13 properties), alarmsAlarmResponse (7 properties), alarmsSyslogDestination (6 properties). Each schema is shown below with its type and property counts.

alarmsRestDestinationList
object
1 property
alarmsSeverity
string
alarmsAlarm
object
20 properties
alarmsSyslogDestination
object
6 properties
alarmsEvent
object
13 properties
alarmsResponseState
string
alarmsNoteAlarmReq
object
3 properties
alarmsAcknowledgeAlarmReq
object
4 properties
alarmsSyslogDestinationList
object
1 property
alarmsGetAlarmsReq
object
2 properties
alarmsRestDestination
object
5 properties
alarmsAlarmResponse
object
7 properties
alarmsClearAlarmReq
object
3 properties
alarmsCategory
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cisco-crosswork-alarms-api-openapi.yml Raw ↑

Other APIs Cisco Crosswork publishes across the network.

Cisco Crosswork Add Credentials API
Cisco Crosswork Add Data Gateway Enrollments API
Cisco Crosswork Add Destinations API
Cisco Crosswork Add Nodes/Devices API
Cisco Crosswork Add Policies API
Cisco Crosswork Add Providers API
Cisco Crosswork Add Tags API
Cisco Crosswork Add via CSV file API
Cisco Crosswork Alert API API
Cisco Crosswork API Controller API
Cisco Crosswork Authconfig API
Cisco Crosswork Backup Services API
Where this information came from

This is an independent, third-party profile of Cisco Crosswork Alarms 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.