{"type":"api","title":"System Health API","meta":{"id":"/apps/pubhub/media/cisco-dna-center-api-2-3-7/3309b3bd96fb020da21f4aafc83d1cba46673bc3/3f2660a3-5586-3ef5-a257-2e69a95dd4c9","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7","version":"2.3.7"},"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":"systemHealthAPI","tags":["Health and Performance"],"summary":"System Health API","description":"This API retrieves the latest system events ","parameters":[{"name":"summary","description":"Fetch the latest high severity event","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"domain","description":"Fetch system events with this domain. Possible values of domain are listed here : /dna/platform/app/consumer-portal/developer-toolkit/events","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"subdomain","description":"Fetch system events with this subdomain. Possible values of subdomain are listed here : /dna/platform/app/consumer-portal/developer-toolkit/events","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"limit","description":"limit","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"offset","description":"offset","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"healthEvents":{"type":"array","items":{"type":"object","properties":{"severity":{"type":"string","description":"Severity of the event"},"hostname":{"type":"string","description":"Hostname of the event"},"instance":{"type":"string","description":"Instance of the event"},"subDomain":{"type":"string","description":"Sub domain of the event"},"domain":{"type":"string","description":"Domain of the event"},"description":{"type":"string","description":"Details of the event"},"state":{"type":"string","description":"State of the event"},"timestamp":{"type":"string","description":"Time of the event occurance"},"status":{"type":"string","description":"Event status"}}},"description":"Array of events"},"version":{"type":"string","description":"API version"},"hostName":{"type":"string","description":"Cluster name "},"cimcaddress":{"type":"array","items":{"type":"string"},"description":"List of configured cimc addresse(s)"}},"description":"","$$ref":"#/components/schemas/SystemHealthAPIResponse"}}}},"204":{"description":"The request was successful, however no content was returned.","content":{}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"401":{"description":"The client's authentication credentials included with the request are missing or invalid.","content":{}},"403":{"description":"The server recognizes the authentication credentials, but the client is not authorized to perform this request.","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"409":{"description":"The target resource is in a conflicted state (for example, an edit conflict where a resource is being edited by multiple users). Retrying the request later might succeed.","content":{}},"415":{"description":"The client sent a request body in a format that the server does not support (for example, XML to a server that only accepts JSON).","content":{}},"500":{"description":"The server could not fulfill the request.","content":{}},"501":{"description":"The server has not implemented the functionality required to fulfill the request.","content":{}},"503":{"description":"The server is (temporarily) unavailable.","content":{}},"504":{"description":"The server did not respond inside time restrictions and timed-out.","content":{}}},"x-rapi-id":"6085-eb1b-4f48-9740","x-rapi-overview":"This API retrieves the latest system events ","x-rapi-domain":"Cisco DNA Center System","x-rapi-subdomain":"Health and Performance","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/diagnostics/system/health","x-rapi-publicPath":"/dna/intent/api/v1/diagnostics/system/health","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"__originalOperationId":"systemHealthAPI","method":"get","path":"/dna/intent/api/v1/diagnostics/system/health"}}