{"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":"ProfileKpiControl is KPI of ID, Cadence, Alerting, Parameters for config.","properties":{"alerting":{"description":"alerting","format":"boolean","title":"Whether generate alerts or not","type":"boolean"},"cadence":{"description":"cadence","format":"int64","title":"KPI Cadence in seconds","type":"integer"},"createdBy":{"description":"createdBy","type":"string"},"creationDate":{"description":"creationDate","format":"int64","type":"integer"},"details":{"description":"details","title":"Pulse kpi details","type":"string"},"downsample_factor":{"description":"downsample_factor","format":"int64","title":"Downsampling rate: How many alerts coming in Cadence will be combined into 1 alert","type":"integer"},"kpi_id":{"description":"kpi_id","title":"Pulse kpi ID","type":"string"},"kpi_name":{"description":"kpi_name","title":"Pulse kpi Name","type":"string"},"kpi_scripts":{"description":"kpi_scripts","items":{"description":"Description for pulseKpiScript","properties":{"alert_template":{"description":"alert_template","title":"Alert Template used by the script","type":"string"},"parameters":{"description":"parameters","items":{"description":"Description for pulseParameter","properties":{"description":{"description":"description","type":"array"},"display_name":{"description":"display_name","type":"array"},"name":{"description":"name","type":"array"},"newValue":{"description":"newValue","type":"array"},"possible_values":{"description":"possible_values","items":{"type":"string"},"type":"array"},"type":{"description":"type","type":"array"},"value":{"description":"value","type":"array"}},"type":"object","$$ref":"#/components/schemas/pulseParameter"},"title":"Alerting Parameters","type":"object"},"script_id":{"description":"script_id","type":"string"}},"type":"object","$$ref":"#/components/schemas/pulseKpiScript"},"title":"Each kpi may have multiple scripts","type":"array"},"lastUpdatedBy":{"description":"lastUpdatedBy","type":"string"},"lastUpdationDate":{"description":"lastUpdationDate","format":"int64","type":"integer"},"summary":{"description":"summary","title":"Pulse kpi Summary","type":"string"}},"type":"object","$$ref":"#/components/schemas/pulseProfileKpiControl","title":"pulseProfileKpiControl"}}