{"type":"model","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/280afeb1-5ea4-33e3-8618-f92d3ecedf8f","info":{"contact":{"email":"support@cisco.com","name":"Crosswork Team, Cisco"},"description":"Health Insights(HI) is a software system that provides smart KPI monitoring and remediation for service provider networks. This document contains details of the HI RESTful APIs that can be used to manage KPIs, enable/disable KPIs on groups or devices, query KPIs and device alerts, remediate alerting KPIs etc.","license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"},"title":"Crosswork Health Insights API","version":"7.1.0"},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/CAHI/health_insights_overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{server_ip}:30603/crosswork/hi/v1","description":"Generated server url"}],"securitySchemes":{"bearerAuth":{"description":"token","in":"header","name":"Authorization","type":"apiKey"}}},"spec":{"description":"Description for pulseAlertsSeriesDtlResp","example":{},"properties":{"time_series":{"description":"time_series","type":"array","properties":{"Results":{"description":"Results","items":{"description":"Description for pulseAlert","properties":{"cdg_id":{"description":"cdg_id","title":"uuid of cdg instance which generated this alert","type":"array"},"context_json":{"description":"context_json","title":"context json provides the key fields for the alert. this is a collection of key-value\npairs what pertain to the alert like interface ID, interface bandwidth. the value of\nthese fields directly contributed to the generation of the alert","type":"array"},"id":{"description":"id","title":"id is the ssc script ID that generated the alert. It might be different from kpi id","type":"array"},"kpi_id":{"description":"kpi_id","title":"kpi id which resulted in this alert","type":"array"},"kpi_profile":{"description":"kpi_profile","title":"kpi profile id which this alert belongs to","type":"array"},"level":{"description":"level","title":"severity of the alert","type":"array"},"misc_json":{"description":"misc_json","title":"miscellaneous json is a collection of key-value pairs of fields that were available in\nthe data point but do not directly contribute to the alert","type":"array"},"msg":{"description":"msg","title":"msg generated by the alerting entity","type":"array"},"producer":{"description":"producer","title":"node_id, typically the hostname, of the device on which this alert was\ngenerated","type":"array"},"state":{"description":"state","title":"state of the alert denotes that current status of the alert itself. when set to clear\nit means that all if well and a previously raised alert has been remediated","type":"array"},"timestamp":{"description":"timestamp","format":"uint64","title":"time at which the alert was generated represented as ns since epoch","type":"array"},"uuid":{"description":"uuid","title":"UUID of the device on which this alert was generated","type":"array"}},"type":"object","$$ref":"#/components/schemas/pulseAlert"},"type":"array"}},"$$ref":"#/components/schemas/pulseAlerts"}},"type":"object","$$ref":"#/components/schemas/pulseAlertsSeriesDtlResp","title":"pulseAlertsSeriesDtlResp"}}