{"type":"api","title":"Compliance Details of Device","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":"complianceDetailsOfDevice","tags":["Compliance"],"summary":"Compliance Details of Device","deprecated":false,"description":"Return compliance detailed report for a device.","parameters":[{"name":"deviceUuid","description":"Device Id","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"},{"name":"category","description":"category can have any value among 'INTENT', 'RUNNING_CONFIG' , 'IMAGE' , 'PSIRT' , 'DESIGN_OOD' , 'EOX' , 'NETWORK_SETTINGS'","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"complianceType","description":"Specify \"Compliance type(s)\" separated by commas. The Compliance type can be 'APPLICATION_VISIBILITY', 'EOX', 'FABRIC', 'IMAGE', 'NETWORK_PROFILE', 'NETWORK_SETTINGS', 'PSIRT', 'RUNNING_CONFIG', 'WORKFLOW'. ","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"diffList","description":"diff list [ pass true to fetch the diff list ]","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"status","description":"'COMPLIANT', 'NON_COMPLIANT', 'ERROR', 'IN_PROGRESS', 'NOT_APPLICABLE', 'NOT_AVAILABLE', 'WARNING', 'REMEDIATION_IN_PROGRESS' can be the value of the compliance 'status' parameter. [COMPLIANT: Device currently meets the compliance requirements. NON_COMPLIANT: One of the compliance requirements like Software Image, PSIRT, Network Profile, Startup vs Running, etc. are not met. ERROR: Compliance is unable to compute status due to underlying errors. IN_PROGRESS: Compliance check is in progress for the device. NOT_APPLICABLE: Device is not supported for compliance, or minimum license requirement is not met. NOT_AVAILABLE: Compliance is not available for the device. COMPLIANT_WARNING: The device is compliant with warning if the last date of support is nearing. REMEDIATION_IN_PROGRESS: Compliance remediation is in progress for the device.]","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"remediationSupported","description":"The 'remediationSupported' parameter can be set to 'true' or 'false'. The result will be a combination of both values if it is not provided.","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"deviceUuid":{"type":"string","description":"UUID of the device."},"complianceType":{"type":"string","description":"Compliance type corresponds to a tile on the UI that will be one of NETWORK_PROFILE, IMAGE, APPLICATION_VISIBILITY, FABRIC, PSIRT, RUNNING_CONFIG, NETWORK_SETTINGS, WORKFLOW, or EOX. "},"status":{"type":"string","description":"Status of compliance for the compliance type, will be one of COMPLIANT, NON_COMPLIANT, ERROR, IN_PROGRESS, NOT_APPLICABLE, NOT_AVAILABLE, WARNING, REMEDIATION_IN_PROGRESS can be the value of the compliance status parameter. [COMPLIANT: Device currently meets the compliance requirements. NON_COMPLIANT: One of the compliance requirements like Software Image, PSIRT, Network Profile, Startup vs Running, etc. are not met. ERROR: Compliance is unable to compute status due to underlying errors. IN_PROGRESS: Compliance check is in progress for the device. NOT_APPLICABLE: Device is not supported for compliance, or minimum license requirement is not met. NOT_AVAILABLE: Compliance is not available for the device. COMPLIANT_WARNING: The device is compliant with warning if the last date of support is nearing. REMEDIATION_IN_PROGRESS: Compliance remediation is in progress for the device.]"},"state":{"type":"string","description":"State of the compliance check for the compliance type, will be one of SUCCESS, FAILED, or IN_PROGRESS. "},"lastSyncTime":{"type":"number","description":"Timestamp when the status changed from a different value to the current value."},"lastUpdateTime":{"type":"number","description":"Timestamp of the latest compliance check that was run."},"sourceInfoList":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the type of top level configuration."},"nameWithBusinessKey":{"type":"string","description":""},"sourceEnum":{"type":"string","description":"Will be same as compliance type. "},"type":{"type":"string","description":"Type of the top level configuration."},"appName":{"type":"string","description":"Application name that is used to club the violations."},"count":{"type":"number","description":"Number of violations present."},"ackStatus":{"type":"string","description":"Acknowledgment status of violations. UNACKNOWLEDGED if none of the violations are acknowledged. Otherwise it will be ACKNOWLEDGED."},"businessKey":{"type":"object","properties":{"resourceName":{"type":"string","description":"Name of the top level resource. Same as name above."},"businessKeyAttributes":{"type":"object","properties":{},"description":"Attributes that together uniquely identify the configuration instance."},"otherAttributes":{"type":"object","properties":{"name":{"type":"string","description":"Name of the attributes."},"cfsAttributes":{"type":"object","properties":{"displayName":{"type":"string","description":" User friendly name for the configuration."},"appName":{"type":"string","description":"Same as appName above."},"description":{"type":"string","description":"Description for the configuration, if available."},"source":{"type":"string","description":"Will be same as compliance type."},"type":{"type":"string","description":"The type of this attribute (for example, type can be Intent)."}},"description":""}},"description":"Data used by graphical user interface. Not applicable for all violations."}},"description":"Object of unique identifier of the configuration instance."},"diffList":{"type":"array","items":{"type":"object","properties":{"op":{"type":"string","description":"Type of change (add, remove, or update)."},"configuredValue":{"type":"string","description":"Configured value i.e. running / current value. It will be empty for the template violations due to potentially large size of the template. Use a dedicated API to get the template data. "},"intendedValue":{"type":"string","description":"Enable\", Intended value. It will be empty for the template violations due to potentially large size of the template. Use a dedicated API to get the template data. "},"moveFromPath":{"type":"string","description":"Additional URI to fetch more details, if available."},"businessKey":{"type":"string","description":"The Unique key of the individual violation does not change after every compliance check, as long as the deployment data doesn't change."},"path":{"type":"string","description":"Path of the configuration relative to the top-level configuration. Use it along with a name to identify certain set of violations."},"extendedAttributes":{"type":"object","properties":{"attributeDisplayName":{"type":"string","description":"Display name for attribute in ui .if business key is null or only owning entity type."},"path":{"type":"string","description":"Path to be displayed on the UI, instead of the above path, if available."},"dataConverter":{"type":"string","description":"Name of the converter used to display configurations in user-friendly format, if available."},"type":{"type":"string","description":"Type of this attribute.(example type can be Intent)"}},"description":"Extra attribute to customize in ui . "},"ackStatus":{"type":"string","description":"Acknowledgment status of the violation. ACKNOWLEDGED if the violation is acknowledged or at the top-level configuration. Otherwise it will be UNACKNOWLEDGED."},"instanceUUID":{"type":"string","description":"UUID of the individual violation. Changes after every compliance check."},"displayName":{"type":"string","description":"Display name for attribute in ui .If business key is null or of type owning entity type."}}},"description":"List of individual violations, under the top-level configuration instance. "},"displayName":{"type":"string","description":"Model display name."}}},"description":"List of violation details. Only valid for NON_COMPLIANT and COMPLIANT_WARNING statuses. One entry per name per instance."},"ackStatus":{"type":"string","description":"Acknowledgment status of the compliance type. UNACKNOWLEDGED if none of the violations under the compliance type are acknowledged. Otherwise it will be ACKNOWLEDGED."},"version":{"type":"string","description":"Version of the API."},"remediationSupported":{"type":"boolean","description":"Indicates whether remediation is supported for this compliance type or not."}}},"description":"Response object, one entry per compliance type and per device."},"deviceUuid":{"type":"string","description":"UUID of the device."}},"description":"","$$ref":"#/components/schemas/ComplianceDetailsOfDeviceResponse"}}}},"204":{"description":"The request was successful, however no content was returned.","content":{}},"206":{"description":"The GET request included a Range Header, and the server responded with the partial content matching the range.","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":{}},"403":{"description":"The server recognises the authentication credentials, but the client is not authorised to perform this request.","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"409":{"description":"The target resource is in a conflicted state (for example, an edit conflict where a resource is being edited by multiple users). Retrying the request later might succeed.","content":{}},"415":{"description":"The client sent a request body in a format that the server does not support (for example, XML to a server that only accepts JSON).","content":{}},"500":{"description":"The server could not fullfill the request.","content":{}},"501":{"description":"The server has not implemented the functionality required to fullfill the request.","content":{}},"503":{"description":"The server is (temporarily) unavailable.","content":{}},"504":{"description":"The server did not respond inside time restrictions and timed-out.","content":{}}},"x-rapi-id":"52bf-e904-45aa-b017","x-rapi-overview":"Return compliance detailed report for a device.","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Compliance","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v2/data/compliance/${deviceUuid}/detail","x-rapi-publicPath":"/dna/intent/api/v1/compliance/${deviceUuid}/detail","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"complianceDetailsOfDevice","method":"get","path":"/dna/intent/api/v1/compliance/{deviceUuid}/detail"}}