{"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 pulseKpiProfileDeviceElem","properties":{"device_id":{"description":"device_id","title":"device id","type":"array"},"enabled_profiles_count":{"description":"enabled_profiles_count","format":"int64","title":"Enabled profiles count for device_id","type":"array"},"kpi_device_profiles":{"description":"kpi_device_profiles","items":{"description":"Description for pulseKpiProfiles","properties":{"KPIProfileId":{"description":"KPIProfileId","title":"kpi profile id","type":"array"},"KpiRefs":{"description":"KpiRefs","items":{"description":"Description for pulseKpiProfileKpiRefElem","properties":{"cadence":{"description":"cadence","format":"uint64","title":"cadence for kpi","type":"array"},"kpi_id":{"description":"kpi_id","title":"kpi id","type":"array"},"kpi_name":{"description":"kpi_name","title":"kpi name","type":"array"},"link":{"description":"link","title":"specifies the grafana dashboard link","type":"array"},"links":{"description":"links","items":{"type":"string"},"title":"specifies the grafana dashboard links if multiple","type":"array"},"profile_id":{"description":"profile_id","title":"kpi profile id","type":"array"},"remediation":{"description":"remediation","type":"array","properties":{"JsonBody":{"description":"JsonBody","type":"array","properties":{"type_url":{"description":"A URL/resource name whose content describes the type of the\nserialized protocol buffer message.\n\nFor URLs which use the scheme `http`, `https`, or no scheme, the\nfollowing restrictions and interpretations apply:\n\n* If no scheme is provided, `https` is assumed.\n* The last segment of the URL's path must represent the fully\n qualified name of the type (as in `path/google.protobuf.Duration`).\n The name should be in a canonical form (e.g., leading \".\" is\n not accepted).\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.","type":"array"},"value":{"description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte","pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","type":"array"}},"$$ref":"#/components/schemas/protobufAny"},"URL":{"description":"URL for the NCA Playbook for this remediation.","type":"array"}},"title":"Remediation contains details of the parameters to remediate an alerting KPI","$$ref":"#/components/schemas/pulseRemediation"},"state":{"description":"state","title":"Specifies state of the kpi on the device","type":"array"}},"title":"KpiProfileKpiRefElem contains details of a single kpi in a kpi profile in context of a device","type":"object","$$ref":"#/components/schemas/pulseKpiProfileKpiRefElem"},"title":"Contains details of the kpis in the kpi profile in context of a device","type":"array"},"state":{"description":"state","type":"array","default":"NONE","enum":["NONE","FAILED","PARTIAL","PROCESSING","ACTIVE"],"$$ref":"#/components/schemas/KpiProfilesProfileStates"}},"title":"KpiProfiles Contains details of the kpis in a kpi profile in context of a device","type":"object","$$ref":"#/components/schemas/pulseKpiProfiles"},"title":"Contains details of kpi profiles enabled on the device","type":"array"}},"title":"pulseKpiProfileDeviceElem","type":"object","$$ref":"#/components/schemas/pulseKpiProfileDeviceElem"}}