{"type":"api","title":"Application Policy Intent","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/b3d6cc9fb9f506b3bc9099912aa8a6f9d87e0f0a/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":"applicationPolicyIntent","tags":["Application Policy"],"deprecated":false,"summary":"Application Policy Intent","description":"Create/Update/Delete application policy","parameters":[{"name":"Content-Type","description":"content-type","required":true,"schema":{"type":"string","default":"application/json"},"in":"header"}],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"object","properties":{"createList":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Concatination of \u003cpolcy name\u003e_\u003capplication-set-name\u003e or \u003cpolcy name\u003e_global_policy_configuration or \u003cpolcy name\u003e_queuing_customization"},"deletePolicyStatus":{"type":"string","enum":["NONE","DELETED","RESTORED"],"description":"NONE: deployed policy to devices, DELETED: delete policy from devices, RESTORED: restored to original configuration"},"policyScope":{"type":"string","description":"Policy name"},"priority":{"type":"string","description":"Set to 4095 while producer refer to application Scalable group otherwise 100"},"advancedPolicyScope":{"type":"object","properties":{"name":{"type":"string","description":"Policy name"},"advancedPolicyScopeElement":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":"array","items":{"type":"string"},"description":"The site(s) ID where the Application QoS Policy will be deployed."},"ssid":{"type":"array","items":{"type":"string"},"description":"Ssid"}}},"description":"Advanced policy scope element"}},"description":"Advanced policy scope"},"exclusiveContract":{"type":"object","properties":{"clause":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["BUSINESS_RELEVANCE","APPLICATION_POLICY_KNOBS"],"description":"Type"},"relevanceLevel":{"type":"string","enum":["BUSINESS_RELEVANT","BUSINESS_IRRELEVANT","DEFAULT"],"description":"Relevance level"},"deviceRemovalBehavior":{"type":"string","enum":["DELETE","RESTORE","IGNORE"],"description":"Device eemoval behavior"},"hostTrackingEnabled":{"type":"boolean","description":"Is host tracking enabled"}}},"description":"Clause"}},"description":"Exclusive contract"},"contract":{"type":"object","properties":{"idRef":{"type":"string","description":"Id ref to Queueing profile"}},"description":"Contract"},"producer":{"type":"object","properties":{"scalableGroup":{"type":"array","items":{"type":"object","properties":{"idRef":{"type":"string","description":"Id ref to application-set or application Scalable group"}}},"description":"Scalable group"}},"description":"Producer"},"consumer":{"type":"object","properties":{"scalableGroup":{"type":"array","items":{"type":"object","properties":{"idRef":{"type":"string","description":"Id ref to application Scalable group"}}},"description":"Scalable group"}},"description":"Consumer"}}},"description":"Create list of Group Based Policy"},"updateList":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id of Group based policy"},"name":{"type":"string","description":"Concatination of \u003cpolcy name\u003e_\u003capplication-set-name\u003e or \u003cpolcy name\u003e_global_policy_configuration or \u003cpolcy name\u003e_queuing_customization"},"deletePolicyStatus":{"type":"string","enum":["NONE","DELETED","RESTORED"],"description":"NONE: deployed policy to devices, DELETED: delete policy from devices, RESTORED: restored to original configuration"},"policyScope":{"type":"string","description":"Policy name"},"priority":{"type":"string","description":"Set to 4095 while producer refer to application Scalable group otherwise 100"},"advancedPolicyScope":{"type":"object","properties":{"id":{"type":"string","description":"Id of Advance policy scope"},"name":{"type":"string","description":"Policy name"},"advancedPolicyScopeElement":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id of Advance policy scope element"},"groupId":{"type":"array","items":{"type":"string"},"description":"The site(s) ID where the Application QoS Policy will be deployed."},"ssid":{"type":"array","items":{"type":"string"},"description":"Ssid"}}},"description":"Advanced policy scope element"}},"description":"Advanced policy scope"},"exclusiveContract":{"type":"object","properties":{"id":{"type":"string","description":"Id of Exclusive contract"},"clause":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id of Business relevance or Application policy knobs clause"},"type":{"type":"string","enum":["BUSINESS_RELEVANCE","APPLICATION_POLICY_KNOBS"],"description":"Type"},"relevanceLevel":{"type":"string","enum":["BUSINESS_RELEVANT","BUSINESS_IRRELEVANT","DEFAULT"],"description":"Relevance level"},"deviceRemovalBehavior":{"type":"string","enum":["DELETE","RESTORE","IGNORE"],"description":"Device removal behavior"},"hostTrackingEnabled":{"type":"boolean","description":"Host tracking enabled"}}},"description":"Clause"}},"description":"Exclusive contract"},"contract":{"type":"object","properties":{"idRef":{"type":"string","description":"Id ref to Queueing profile"}},"description":"Contract"},"producer":{"type":"object","properties":{"id":{"type":"string","description":"Id of Producer"},"scalableGroup":{"type":"array","items":{"type":"object","properties":{"idRef":{"type":"string","description":"Id ref to application-set or application Scalable group"}}},"description":"Scalable group"}},"description":"Producer"},"consumer":{"type":"object","properties":{"id":{"type":"string","description":"Id of Consumer"},"scalableGroup":{"type":"array","items":{"type":"object","properties":{"idRef":{"type":"string","description":"Id ref to application Scalable group"}}},"description":"Scalable group"}},"description":"Consumer"}}},"description":"Update list of Group Based Policy"},"deleteList":{"type":"array","items":{"type":"string"},"description":"Delete list of Group Based Policy ids"}},"description":"","$$ref":"#/components/schemas/ApplicationPolicyIntentRequest"}}},"required":true},"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"taskId":{"type":"string","description":"Task id"},"url":{"type":"string","description":"Task url"}},"description":"Response"},"version":{"type":"string","description":"Version"}},"description":"","$$ref":"#/components/schemas/ApplicationPolicyIntentResponse"}}}},"202":{"description":"The request was accepted for processing, but the processing has not been completed.","content":{}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"401":{"description":"The client's authentication credentials included with the request are missing or invalid.","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"500":{"description":"The server could not fulfill the request.","content":{}}},"x-rapi-id":"aea4-bb7b-4329-bd06","x-rapi-overview":"Create/Update/Delete application policy","x-rapi-domain":"Policy","x-rapi-subdomain":"Application Policy","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v2/data/cfs-intent/policy/application","x-rapi-publicPath":"/dna/intent/api/v1/app-policy-intent","x-rapi-registerInKONG":true,"x-rapi-banner":[],"__originalOperationId":"applicationPolicyIntent","method":"post","path":"/dna/intent/api/v1/app-policy-intent"}}