{"type":"api","title":"Get device deployment status","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":"getDeviceDeploymentStatus_","tags":["Sensors"],"summary":"Get device deployment status.","deprecated":false,"description":"Retrieves ICAP configuration deployment status(s) per device based on filter criteria. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-ICAP_APIs-1.0.0-resolved.yaml","parameters":[{"name":"deployActivityId","description":"activity from the /deploy task response","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"networkDeviceIds","description":"device ids, retrievable from the id attribute in intent/api/v1/network-device","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"offset","description":"The first record to show for this page; the first record is numbered 1.","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"limit","description":"The number of records to show for this page.","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"sortBy","description":"A property within the response to sort by.","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"order","description":"Whether ascending or descending order should be used to sort the response.","schema":{"type":"string","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"activityId":{"type":"string","description":"Activity id from intent/api/v1/activity.example: 7f422eeb-effe-4938-9371-ccf6dc2fe15e"},"configGroupName":{"type":"string","description":"Name of the config group that has been provisioned. example: application.telemetry"},"configGroupVersion":{"type":"integer","description":"Version of the config group that has been provisioned. The version increments everytime for a provisioning operation."},"status":{"type":"string","enum":["NOT_STARTED","SUCCESS","FAILED","CONFIGURING","ROLLBACK_SUCCESS","ROLLBACK_FAILURE","CANCELLED","NOT_SUPPORTED","PENDING"],"description":"Provisioning status on the device."},"networkDeviceId":{"type":"string","description":"Network device ID of the wired device to provision. The API /intent/api/v1/network-device can be used to get the network device ID."},"createTime":{"type":"integer","description":"Create time of the service deployment status record; as measured in Unix epoch time in milliseconds."},"lastUpdateTime":{"type":"integer","description":"Last update time of the service deployment status record; as measured in Unix epoch time in milliseconds."},"startTime":{"type":"integer","description":"Service provisioning task start time; as measured in Unix epoch time in milliseconds."},"endTime":{"type":"integer","description":"Service provisioning task end time; as measured in Unix epoch time in milliseconds."},"error":{"type":"object","properties":{"message":{"type":"string","description":"A brief message about the error.example: Connection to device timedout"},"remedy":{"type":"string","description":"A brief message to suggest remedy to the failure. example: Upgrade the IOS version"}},"description":"Device Deployment error details"}}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/GetDeviceDeploymentStatusResponse"}}}},"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 recognizes the authentication credentials, but the client is not authorized 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 fulfill the request.","content":{}},"501":{"description":"The server has not implemented the functionality required to fulfill 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":"5aa1-1ac0-4d28-af86","x-rapi-overview":"Retrieves ICAP configuration deployment status(s) per device based on filter criteria. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-ICAP_APIs-1.0.0-resolved.yaml","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Sensors","x-rapi-version":"1.0.0","x-rapi-internalPath":"/dna/intent/api/v1/icapSettings/deviceDeployments","x-rapi-publicPath":"/dna/intent/api/v1/icapSettings/deviceDeployments","x-rapi-registerInKONG":false,"x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"50~MINUTE","__originalOperationId":"getDeviceDeploymentStatus.","method":"get","path":"/dna/intent/api/v1/icapSettings/deviceDeployments"}}