Create a profiling rule - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Create a profiling rule","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/a58b8872fdc3116cb1a0478252ee81e8011d37c2/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"createAProfilingRule","tags":["AI Endpoint Analytics"],"deprecated":false,"summary":"Create a profiling rule","description":"Creates profiling rule from the request body.","parameters":[{"name":"Content-Type","description":"Request body content type","required":true,"schema":{"type":"string","default":"application/json"},"in":"header"}],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"object","properties":{"ruleId":{"type":"string","description":"Unique identifier for the rule. This is normally generated by the system, and client does not need to provide\nit for rules that need to be newly created.\n"},"ruleName":{"type":"string","description":"Human readable name for the rule."},"ruleType":{"type":"string","enum":["Cisco Default - Static","Cisco Default - Dynamic","Custom Rule","ML Rule"],"description":"Type of the rule."},"ruleVersion":{"type":"integer","description":"Version of the rule."},"rulePriority":{"type":"integer","description":"Priority for the rule."},"sourcePriority":{"type":"integer","description":"Source priority for the rule."},"isDeleted":{"type":"boolean","description":"Flag to indicate whether the rule was deleted."},"lastModifiedBy":{"type":"string","description":"User that last modified the rule. It is read-only, and is ignored if provided as part of input request."},"lastModifiedOn":{"type":"integer","description":"Timestamp (in epoch milliseconds) of last modification. It is read-only, and is ignored if provided as part of\ninput request.\n"},"pluginId":{"type":"string","description":"Plugin for the rule. Only applicable for 'Cisco Default' rules."},"clusterId":{"type":"string","description":"Unique identifier for ML cluster. Only applicable for 'ML Rule'."},"rejected":{"type":"boolean","description":"Flag to indicate whether rule has been rejected by user or not. Only applicable for 'ML Rule'."},"result":{"type":"object","properties":{"deviceType":{"type":"array","items":{"type":"string"},"description":"List of device types determined by the current rule."},"hardwareManufacturer":{"type":"array","items":{"type":"string"},"description":"List of hardware manufacturers determined by the current rule."},"hardwareModel":{"type":"array","items":{"type":"string"},"description":"List of hardware models determined by the current rule."},"operatingSystem":{"type":"array","items":{"type":"string"},"description":"List of operating systems determined by the current rule."}},"description":"Object containing profiling result as determined by the rule."},"conditionGroups":{"type":"object","properties":{"type":{"type":"string","enum":["attr","classification"],"description":""},"condition":{"type":"object","properties":{"attribute":{"type":"string","description":""},"operator":{"type":"string","enum":["equals","contains","startswith","matches"],"description":""},"value":{"type":"string","description":""},"attributeDictionary":{"type":"string","description":""}},"description":""},"operator":{"type":"string","enum":["and","or"],"description":""},"conditionGroup":{"type":"array","items":{"type":"string"},"description":""}},"description":"Complex object that describes various conditions that should be met for the current rule to be applied."},"usedAttributes":{"type":"array","items":{"type":"string"},"description":"List of attributes used in the rule. Only applicable for 'Cisco Default' rules."}},"description":"","$$ref":"#/components/schemas/CreateAProfilingRuleRequest"}}},"required":true},"responses":{"200":{"description":"Profiling rule created successfully. Response contains the id and link to the newly created resource.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the newly created resource."},"link":{"type":"string","description":"Link to the newly created resource."}},"description":"","$$ref":"#/components/schemas/CreateAProfilingRuleResponse"}}}},"400":{"description":"Invalid request. Check response body for more details.","content":{}},"500":{"description":"Internal server error. Check response body for more details.","content":{}}},"x-rapi-id":"6cb9-98bb-47ea-90f6","x-rapi-overview":"Creates profiling rule from the request body.","x-rapi-domain":"Policy","x-rapi-subdomain":"AI Endpoint Analytics","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/endpoint-analytics/v1/eps/profiling-rules","x-rapi-publicPath":"/dna/intent/api/v1/endpoint-analytics/profiling-rules","x-rapi-registerInKONG":true,"x-rapi-banner":[],"__originalOperationId":"createAProfilingRule","method":"post","path":"/dna/intent/api/v1/endpoint-analytics/profiling-rules"}}