Query assurance events - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Query assurance events","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/a58b8872fdc3116cb1a0478252ee81e8011d37c2/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"queryAssuranceEvents","tags":["Devices"],"summary":"Query assurance events","deprecated":false,"description":"Returns the list of events discovered by Catalyst Center, determined by the complex filters. Please refer to the 'API Support Documentation' section to understand which fields are supported. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-AssuranceEvents-1.0.0-resolved.yaml","parameters":[{"name":"X-CALLER-ID","description":"Caller ID is used to trace the origin of API calls and their associated queries executed on the database. It's an optional header parameter that can be added to an API request.\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"deviceFamily","description":"Device family. Please note that multiple families across network device type and client type is not allowed. For example, choosing `Routers` along with `Wireless Client` or `Unified AP` is not supported.\nExamples:\n\n`deviceFamily=Switches and Hubs` (single deviceFamily requested)\n\n`deviceFamily=Switches and Hubs&deviceFamily=Routers` (multiple deviceFamily requested)\n","required":true,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"startTime","description":"Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.\n\nIf `startTime` is not provided, API will default to current time minus 24 hours.\n","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"endTime","description":"End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.\n\nIf `endTime` is not provided, API will default to current time.\n","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"messageType","description":"Message type for the event.\n\nExamples:\n\n`messageType=Syslog` (single messageType requested)\n\n`messageType=Trap&messageType=Syslog` (multiple messageType requested)\n","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"severity","description":"Severity of the event between 0 and 6. This is applicable only for events related to network devices (other than AP) and `Wired Client` events.\n\n| Value | Severity |\n| ----- | ----------- |\n| 0 | Emergency |\n| 1 | Alert |\n| 2 | Critical |\n| 3 | Error |\n| 4 | Warning |\n| 5 | Notice |\n| 6 | Info |\n\nExamples:\n\n`severity=0` (single severity requested)\n\n`severity=0&severity=1` (multiple severity requested)\n","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"siteId","description":"The UUID of the site. (Ex. `flooruuid`)\n\nExamples:\n\n`?siteId=id1` (single siteId requested)\n\n`?siteId=id1&siteId=id2&siteId=id3` (multiple siteId requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"siteHierarchyId","description":"The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. `globalUuid/areaUuid/buildingUuid/floorUuid`)\n\nThis field supports wildcard asterisk (`*`) character search support. E.g. `*uuid*, *uuid, uuid*`\n\nExamples:\n\n`?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested)\n\n`?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId=globalUuid/areaUuid2/buildingUuid2/floorUuid2` (multiple siteHierarchyId requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"networkDeviceName","description":"Network device name. This parameter is applicable for network device related families.\nThis field supports wildcard (`*`) character-based search. Ex: `*Branch*` or `Branch*` or `*Branch`\nExamples:\n\n`networkDeviceName=Branch-3-Gateway` (single networkDeviceName requested)\n\n`networkDeviceName=Branch-3-Gateway&networkDeviceName=Branch-3-Switch` (multiple networkDeviceName requested)\n","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"networkDeviceId","description":"The list of Network Device Uuids. (Ex. `6bef213c-19ca-4170-8375-b694e251101c`)\n\nExamples:\n\n`networkDeviceId=6bef213c-19ca-4170-8375-b694e251101c` (single networkDeviceId requested)\n\n`networkDeviceId=6bef213c-19ca-4170-8375-b694e251101c&networkDeviceId=32219612-819e-4b5e-a96b-cf22aca13dd9&networkDeviceId=2541e9a7-b80d-4955-8aa2-79b233318ba0` (multiple networkDeviceId with & separator)\n","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"apMac","description":"MAC address of the access point. This parameter is applicable for `Unified AP` and `Wireless Client` events.\n\nThis field supports wildcard (`*`) character-based search. Ex: `*50:0F*` or `50:0F*` or `*50:0F`\n\nExamples:\n\n`apMac=50:0F:80:0F:F7:E0` (single apMac requested)\n\n`apMac=50:0F:80:0F:F7:E0&apMac=18:80:90:AB:7E:A0` (multiple apMac requested)\n","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"clientMac","description":"MAC address of the client. This parameter is applicable for `Wired Client` and `Wireless Client` events.\n\nThis field supports wildcard (`*`) character-based search. Ex: `*66:2B*` or `66:2B*` or `*66:2B`\n\nExamples:\n\n`clientMac=66:2B:B8:D2:01:56` (single clientMac requested)\n\n`clientMac=66:2B:B8:D2:01:56&clientMac=DC:A6:32:F5:5A:89` (multiple clientMac requested)\n","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"attribute","description":"The list of attributes that needs to be included in the response. If this parameter is not provided, then basic attributes (`id`, `name`, `timestamp`, `details`, `messageType`, `siteHierarchyId`, `siteHierarchy`, `deviceFamily`, `networkDeviceId`, `networkDeviceName`, `managementIpAddress`) would be part of the response.\n Examples:\n\n`attribute=name` (single attribute requested)\n\n`attribute=name&attribute=networkDeviceName` (multiple attribute requested)\n","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"view","description":"The list of events views. Please refer to `EventViews` for the supported list\n Examples:\n\n`view=network` (single view requested)\n\n`view=network&view=ap` (multiple view requested)\n","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"offset","description":"Specifies the starting point within all records returned by the API. It's one based offset. The starting value is 1.","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"limit","description":"Maximum number of records to return","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"sortBy","description":"A field within the response to sort by.","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"order","description":"The sort order of the field ascending or descending.","schema":{"type":"string","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"List of events for the given filter criteria","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"oldRadioChannelWidth":{"type":"string","description":""},"clientMac":{"type":"string","description":""},"switchNumber":{"type":"string","description":""},"assocRssi":{"type":"integer","description":""},"affectedClients":{"type":"array","items":{"type":"string"},"description":""},"isPrivateMac":{"type":"boolean","description":""},"frequency":{"type":"string","description":""},"apRole":{"type":"string","description":""},"replacingDeviceSerialNumber":{"type":"string","description":""},"messageType":{"type":"string","description":""},"failureCategory":{"type":"string","description":""},"apSwitchName":{"type":"string","description":""},"apSwitchId":{"type":"string","description":""},"radioChannelUtilization":{"type":"string","description":""},"mnemonic":{"type":"string","description":""},"radioChannelSlot":{"type":"integer","description":""},"details":{"type":"string","description":""},"id":{"type":"string","description":""},"lastApDisconnectReason":{"type":"string","description":""},"networkDeviceName":{"type":"string","description":""},"identifier":{"type":"string","description":""},"reasonDescription":{"type":"string","description":""},"vlanId":{"type":"string","description":""},"udnId":{"type":"string","description":""},"auditSessionId":{"type":"string","description":""},"apMac":{"type":"string","description":""},"deviceFamily":{"type":"string","description":""},"radioNoise":{"type":"string","description":""},"wlcName":{"type":"string","description":""},"apRadioOperationState":{"type":"string","description":""},"name":{"type":"string","description":""},"failureIpAddress":{"type":"string","description":""},"newRadioChannelList":{"type":"string","description":""},"duid":{"type":"string","description":""},"roamType":{"type":"string","description":""},"candidateAPs":{"type":"array","items":{"type":"object","properties":{"apId":{"type":"string","description":""},"apName":{"type":"string","description":""},"apMac":{"type":"string","description":""},"bssid":{"type":"string","description":""},"rssi":{"type":"integer","description":""}}},"description":""},"replacedDeviceSerialNumber":{"type":"string","description":""},"oldRadioChannelList":{"type":"string","description":""},"ssid":{"type":"string","description":""},"subReasonDescription":{"type":"string","description":""},"wirelessClientEventEndTime":{"type":"integer","description":""},"ipv4":{"type":"string","description":""},"wlcId":{"type":"string","description":""},"ipv6":{"type":"string","description":""},"missingResponseAPs":{"type":"array","items":{"type":"object","properties":{"apId":{"type":"string","description":""},"apName":{"type":"string","description":""},"apMac":{"type":"string","description":""},"bssid":{"type":"string","description":""},"type":{"type":"string","description":""},"frameType":{"type":"string","description":""}}},"description":""},"timestamp":{"type":"integer","description":""},"severity":{"type":"integer","description":""},"currentRadioPowerLevel":{"type":"integer","description":""},"newRadioChannelWidth":{"type":"string","description":""},"assocSnr":{"type":"integer","description":""},"authServerIp":{"type":"string","description":""},"childEvents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":""},"name":{"type":"string","description":""},"timestamp":{"type":"integer","description":""},"wirelessEventType":{"type":"integer","description":""},"details":{"type":"string","description":""},"reasonCode":{"type":"string","description":""},"reasonDescription":{"type":"string","description":""},"subReasonCode":{"type":"string","description":""},"subReasonDescription":{"type":"string","description":""},"resultStatus":{"type":"string","description":""},"failureCategory":{"type":"string","description":""}}},"description":""},"connectedInterfaceName":{"type":"string","description":""},"dhcpServerIp":{"type":"string","description":""},"managementIpAddress":{"type":"string","description":""},"previousRadioPowerLevel":{"type":"integer","description":""},"resultStatus":{"type":"string","description":""},"radioInterference":{"type":"string","description":""},"networkDeviceId":{"type":"string","description":""},"siteHierarchy":{"type":"string","description":""},"eventStatus":{"type":"string","description":""},"wirelessClientEventStartTime":{"type":"integer","description":""},"siteHierarchyId":{"type":"string","description":""},"udnName":{"type":"string","description":""},"facility":{"type":"string","description":""},"lastApResetType":{"type":"string","description":""},"invalidIeAPs":{"type":"array","items":{"type":"object","properties":{"apId":{"type":"string","description":""},"apName":{"type":"string","description":""},"apMac":{"type":"string","description":""},"bssid":{"type":"string","description":""},"type":{"type":"string","description":""},"frameType":{"type":"string","description":""},"ies":{"type":"string","description":""}}},"description":""},"username":{"type":"string","description":""}}},"description":""},"version":{"type":"string","description":""},"page":{"type":"object","properties":{"limit":{"type":"integer","description":""},"offset":{"type":"integer","description":""},"count":{"type":"integer","description":""},"sortBy":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":""},"order":{"type":"string","description":""}}},"description":""}},"description":""}},"description":"","$$ref":"#/components/schemas/QueryAssuranceEventsResponse"}}}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"500":{"description":"The server could not fulfill the request due to internal server error","content":{}},"1XX":{"description":"Informational Responses - The server received the request and sent an informational response.","content":{}},"2XX":{"description":"Successful Responses - The server received the client request, understood it, and accepted it.","content":{}},"3XX":{"description":"Redirection Messages - The client must take additional action to complete the request.","content":{}},"4XX":{"description":"Client Error Responses - The client request caused the error.","content":{}},"5XX":{"description":"Server Error Responses - The server failed to fulfill the request.","content":{}},"default":{"description":"Unexpected Error","content":{}}},"x-rapi-id":"15a5-3b2c-4908-8ba3","x-rapi-overview":"Returns the list of events discovered by Catalyst Center, determined by the complex filters. Please refer to the 'API Support Documentation' section to understand which fields are supported. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-AssuranceEvents-1.0.0-resolved.yaml","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Devices","x-rapi-version":"1.0.0","x-rapi-internalPath":"/data/api/v1/assuranceEvents","x-rapi-publicPath":"/dna/data/api/v1/assuranceEvents","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"queryAssuranceEvents","method":"get","path":"/dna/data/api/v1/assuranceEvents"}}