{"type":"api","title":"Get provisioned devices","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-5/ecd3d4a3af2416cfe75abdcbafe8872a1063f873/abeeaa12-2d40-3ef9-96fe-e95992ad0458","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.5","version":"2.3.7.5"},"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":"getProvisionedDevices","tags":["SDA"],"summary":"Get provisioned devices","description":"Returns the list of provisioned devices based on query parameters.","parameters":[{"name":"id","description":"ID of the provisioned device.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"networkDeviceId","description":"ID of the network device.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"siteId","description":"ID of the site hierarchy.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"offset","description":"Starting record for pagination.","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"limit","description":"Maximum number of devices to return.","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"Response body contains the result data based on search criteria.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the port assignment."},"fabricId":{"type":"string","description":"ID of the fabric this device belongs to."},"networkDeviceId":{"type":"string","description":"Network device ID of the port assignment."},"interfaceName":{"type":"string","description":"Interface name of the port assignment."},"connectedDeviceType":{"type":"string","enum":["USER_DEVICE","ACCESS_POINT","TRUNKING_DEVICE","AUTHENTICATOR_SWITCH","SUPPLICANT_BASED_EXTENDED_NODE"],"description":"Connected device type of the port assignment."},"dataVlanName":{"type":"string","description":"Data VLAN name of the port assignment."},"voiceVlanName":{"type":"string","description":"Voice VLAN name of the port assignment."},"authenticateTemplateName":{"type":"string","enum":["No Authentication","Open Authentication","Closed Authentication","Low Impact"],"description":"Authenticate template name of the port assignment."},"scalableGroupName":{"type":"string","description":"Scalable group name of the port assignment."},"interfaceDescription":{"type":"string","description":"Interface description of the port assignment."}}},"description":"Get response body."},"version":{"type":"string","description":"Version number."}},"required":["response","version"],"description":"Port assignment get response (Maximum number of records to return in each response is 50).","$$ref":"#/components/schemas/getApiResponseSchema"}}}},"400":{"description":"Bad Request. The client made a request that the server could not understand.","content":{}},"500":{"description":"Internal Server Error. The server could not fulfill the request.","content":{}}},"x-rapi-id":"99b3-ba27-4fe9-9e6b","x-rapi-overview":"Returns the list of provisioned devices based on query parameters.","x-rapi-domain":"Connectivity","x-rapi-subdomain":"SDA","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/sda-helper-service/sda-open-api/provisionDevices","x-rapi-publicPath":"/dna/intent/api/v1/sda/provisionDevices","x-rapi-registerInKONG":true,"x-rapi-banner":["Beta"],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"getProvisionedDevices","method":"get","path":"/dna/intent/api/v1/sda/provisionDevices"}}