{"type":"api","title":"Enable KPI Profiles on devices","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":{"operationId":"EnableKpiProfilesDevices","requestBody":{"content":{"application/json":{"schema":{"description":"Description for pulseKpiProfileAssocDeleteWriteReq","example":{"devices":["RouterFremont","RouterSFO","RouterSanfrancisco","RouterMilpitas"],"kpi_profiles":["cpuprofile","memprofile"],"tags":[]},"properties":{"devices":{"description":"devices","items":{"type":"string"},"title":"List of devices to be enabled with the KPI profiles or to query","type":"array"},"kpi_profiles":{"description":"kpi_profiles","items":{"type":"string"},"title":"List of kpi profiles to be enabled or to query","type":"array"},"tags":{"description":"List of DLM tags to be enabled with the KPI profiles\nNote that either devices or DLM tags should be passed in to the api.","items":{"type":"string"},"type":"array"}},"title":"KpiProfileAssocReq defines the parameters used in POST request to:\n1) Enable KPI Profiles on devices (list of devices/DLM device tags and KPI Profiles can be passed in)\n2) Disable KPI Profiles on devices (list of devices/DLM device tags and KPI Profiles can be passed in)\n3) Query KPI Profiles on devices. The user can send a list of devices, Kpi Profiles and limit+offset for pagination","type":"object","$$ref":"#/components/schemas/pulseKpiProfileAssocDeleteWriteReq"}}},"description":"write KPI Profiles on devices","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"description":"Description for pulseKpiProfileAssocWriteResp","example":{},"properties":{"spanid":{"description":"spanid","format":"int64","title":"Span ID","type":"array"},"txid":{"description":"txid","format":"int64","title":"Transaction ID","type":"array"}},"title":"ProfileAssocWrite Response","type":"object","$$ref":"#/components/schemas/pulseKpiProfileAssocWriteResp"}}},"description":"A successful response."},"400":{"content":{},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"description":"Description for error","example":"Internal Server Error","type":"string","$$ref":"#/components/schemas/error"}}},"description":"Internal Server Error"}},"summary":"Enable KPI Profiles on devices","tags":["KPI Profile / Device(s) Enable/Disable/Jobs"],"x-codegen-request-body-name":"body","__originalOperationId":"EnableKpiProfilesDevices","security":[{"bearerAuth":[]}],"method":"post","path":"/kpiprofileassoc/write"}}