{"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 pulseProfileControlBatch","example":{},"properties":{"profile_controls":{"description":"profile_controls","items":{"description":"A ProfileControl consists of a ProfileControl with a state and state description.","example":{"comp_kpis":[{"comp_id":"audit","createdBy":"lgtest","creationDate":1589441569,"lastUpdatedBy":"lgtest","lastUpdationDate":1589441569,"name":"audit","summary":"audit"}],"created_by":"admin","creation_date":1589441331,"description":"audit","device_count":0,"enabled_on_device":false,"id":"audit","kpis":[{"alerting":true,"cadence":600,"cadence_options":{"default":600,"increment":60,"max":1800,"min":600},"created_by":"admin","creation_date":1589441331,"details":"Monitors device uptime","downsample_factor":1,"kpi_id":"pulse_device_uptime","kpi_name":"Device uptime","kpi_scripts":[{"alert_template":"One Level(Lower) Threshold","parameters":{"parameter":[{"description":"Device uptime in seconds below which alert is raised to detect recent reboot of the device","display_name":"Alert Threshold","name":"ALERT_THRESHOLD","type":"float","value":"1800.0"}]},"script_id":"pulse_device_uptime_template.json"}],"last_updated_by":"lgtest","last_updation_date":1589441537,"summary":"Monitors device uptime"},{"alerting":true,"cadence":60,"cadence_options":{"default":60,"increment":10,"max":900,"min":10},"created_by":"admin","creation_date":1589441331,"details":"Monitors CPU usage across route processor and line cards on routers; generates an alert when CPU utilization exceeds the configured threshold","downsample_factor":1,"kpi_id":"pulse_cpu_threshold","kpi_name":"CPU threshold","kpi_scripts":[{"alert_template":"Two Level Threshold","parameter":[{"description":"Generates a level 1 alert when this threshold is exceeded","display_name":"Level 1 Alert Threshold","name":"LEVEL1_THRESHOLD","type":"float","value":"50.0"},{"description":"Severity label of a level 1 alert","display_name":"Level 1 Alert Severity","name":"LEVEL1_SEVERITY","possible_values":["CRITICAL","WARNING","MAJOR","MINOR","INFO"],"type":"string","value":"WARNING"},{"description":"Generates a level 2 alert when this threshold is exceeded","display_name":"Level 2 Alert Threshold","name":"LEVEL2_THRESHOLD","type":"float","value":"70.0"},{"description":"Severity label of a level 2 alert","display_name":"Level 2 Alert Severity","name":"LEVEL2_SEVERITY","possible_values":["CRITICAL","WARNING","MAJOR","MINOR","INFO"],"type":"string","value":"CRITICAL"}],"script_id":"pulse_cpu_threshold_template.json"}],"last_updated_by":"lgtest","last_updation_date":1589441544,"summary":"Monitors CPU usage across route processor and line cards on routers"}],"last_modified_time":1589441544568768300,"last_updated_by":"lgtest","name":"audit","state":"READY","state_desc":"READY"},"properties":{"comp_kpis":{"description":"comp_kpis","items":{"description":"Description for pulseBasicCompKpi","properties":{"comp_id":{"description":"comp_id","type":"string"},"createdBy":{"description":"createdBy","type":"string"},"creationDate":{"description":"creationDate","format":"int64","type":"integer"},"details":{"description":"details","type":"string"},"lastUpdatedBy":{"description":"lastUpdatedBy","type":"string"},"lastUpdationDate":{"description":"lastUpdationDate","format":"int64","type":"integer"},"name":{"description":"name","type":"string"},"summary":{"description":"summary","type":"string"}},"title":"Basic composit kpi info","type":"object","$$ref":"#/components/schemas/pulseBasicCompKpi"},"title":"Array of basic composite kpis","type":"array"},"createdBy":{"description":"createdBy","type":"string"},"creationDate":{"description":"creationDate","format":"int64","type":"integer"},"description":{"description":"description","type":"string"},"device_count":{"description":"device_count","format":"int64","title":"count of devices in active state","type":"integer"},"enabled_on_device":{"description":"enabled_on_device","format":"boolean","title":"Whether has been enabled on device","type":"boolean"},"id":{"description":"id","type":"string"},"kpis":{"description":"kpis","items":{"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"},"type":"array"},"lastUpdatedBy":{"description":"lastUpdatedBy","type":"string"},"last_modified_time":{"description":"last_modified_time","format":"int64","title":"Last modified timestamp (in Unix epoch ns)","type":"integer"},"name":{"description":"name","type":"string"},"state":{"description":"state","type":"array","default":"INPROGRESS","enum":["INPROGRESS","READY","FAILED","DELETING"],"title":"- INPROGRESS: Not used yet.\n - READY: Alerting configured successfully.\n - FAILED: Alerting config failed or config parameters are wrong\n - DELETING: Being deleted","$$ref":"#/components/schemas/ProfileControlProfileState"},"state_desc":{"description":"state_desc","type":"string"}},"type":"object","$$ref":"#/components/schemas/pulseProfileControl"},"type":"array"},"profiles_count":{"description":"profiles_count","format":"int64","title":"total count of profiles","type":"array"},"total_filtered_profiles_count":{"description":"total_filtered_profiles_count","format":"int64","title":"total filtered count of profiles","type":"array"}},"title":"pulseProfileControlBatch","type":"object","$$ref":"#/components/schemas/pulseProfileControlBatch"}}