Import Devices in bulk - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Import Devices in bulk","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":"importDevicesInBulk","tags":["Device Onboarding (PnP)"],"deprecated":false,"summary":"Import Devices in bulk","description":"Add devices to PnP in bulk","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":"array","items":{"type":"object","properties":{"_id":{"type":"string","description":""},"deviceInfo":{"type":"object","properties":{"serialNumber":{"type":"string","description":""},"stack":{"type":"boolean","description":""},"description":{"type":"string","description":""},"macAddress":{"type":"string","description":""},"pid":{"type":"string","description":""},"siteId":{"type":"string","description":""},"sudiRequired":{"type":"boolean","description":""},"deviceSudiSerialNos":{"type":"array","items":{"type":"string"},"description":""},"userMicNumbers":{"type":"array","items":{"type":"string"},"description":""},"userSudiSerialNos":{"type":"array","items":{"type":"string"},"description":""},"workflowId":{"type":"string","description":""},"workflowName":{"type":"string","description":""},"hostname":{"type":"string","description":""},"stackInfo":{"type":"object","properties":{"supportsStackWorkflows":{"type":"boolean","description":""},"isFullRing":{"type":"boolean","description":""},"stackMemberList":{"type":"array","items":{"type":"object","properties":{"serialNumber":{"type":"string","description":""},"state":{"type":"string","description":""},"role":{"type":"string","description":""},"macAddress":{"type":"string","description":""},"pid":{"type":"string","description":""},"licenseLevel":{"type":"string","description":""},"licenseType":{"type":"string","description":""},"sudiSerialNumber":{"type":"string","description":""},"hardwareVersion":{"type":"string","description":""},"stackNumber":{"type":"number","description":""},"softwareVersion":{"type":"string","description":""},"priority":{"type":"number","description":""}}},"description":""},"stackRingProtocol":{"type":"string","description":""},"validLicenseLevels":{"type":"array","items":{"type":"string"},"description":""},"totalMemberCount":{"type":"number","description":""}},"description":""}},"description":""}}},"description":"","$$ref":"#/components/schemas/ImportDevicesInBulkRequest"}}},"required":true},"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"successList":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":""},"deviceInfo":{"type":"object","properties":{"source":{"type":"string","description":""},"serialNumber":{"type":"string","description":""},"stack":{"type":"boolean","description":""},"mode":{"type":"string","description":""},"state":{"type":"string","description":""},"location":{"type":"object","properties":{"siteId":{"type":"string","description":""},"address":{"type":"string","description":""},"latitude":{"type":"string","description":""},"longitude":{"type":"string","description":""},"altitude":{"type":"string","description":""}},"description":""},"description":{"type":"string","description":""},"onbState":{"type":"string","description":""},"authenticatedMicNumber":{"type":"string","description":""},"authenticatedSudiSerialNo":{"type":"string","description":""},"capabilitiesSupported":{"type":"array","items":{"type":"string"},"description":""},"featuresSupported":{"type":"array","items":{"type":"string"},"description":""},"cmState":{"type":"string","description":""},"firstContact":{"type":"number","description":""},"lastContact":{"type":"number","description":""},"macAddress":{"type":"string","description":""},"pid":{"type":"string","description":""},"deviceSudiSerialNos":{"type":"array","items":{"type":"string"},"description":""},"lastUpdateOn":{"type":"number","description":""},"workflowId":{"type":"string","description":""},"workflowName":{"type":"string","description":""},"projectId":{"type":"string","description":""},"projectName":{"type":"string","description":""},"deviceType":{"type":"string","description":""},"agentType":{"type":"string","description":""},"imageVersion":{"type":"string","description":""},"fileSystemList":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":""},"writeable":{"type":"boolean","description":""},"freespace":{"type":"number","description":""},"name":{"type":"string","description":""},"readable":{"type":"boolean","description":""},"size":{"type":"number","description":""}}},"description":""},"pnpProfileList":{"type":"array","items":{"type":"object","properties":{"profileName":{"type":"string","description":""},"discoveryCreated":{"type":"boolean","description":""},"createdBy":{"type":"string","description":""},"primaryEndpoint":{"type":"object","properties":{"port":{"type":"number","description":""},"protocol":{"type":"string","description":""},"ipv4Address":{"type":"object","properties":{},"description":""},"ipv6Address":{"type":"object","properties":{},"description":""},"fqdn":{"type":"string","description":""},"certificate":{"type":"string","description":""}},"description":""},"secondaryEndpoint":{"type":"object","properties":{"port":{"type":"number","description":""},"protocol":{"type":"string","description":""},"ipv4Address":{"type":"object","properties":{},"description":""},"ipv6Address":{"type":"object","properties":{},"description":""},"fqdn":{"type":"string","description":""},"certificate":{"type":"string","description":""}},"description":""}}},"description":""},"imageFile":{"type":"string","description":""},"httpHeaders":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":""},"value":{"type":"string","description":""}}},"description":""},"neighborLinks":{"type":"array","items":{"type":"object","properties":{"localInterfaceName":{"type":"string","description":""},"localShortInterfaceName":{"type":"string","description":""},"localMacAddress":{"type":"string","description":""},"remoteInterfaceName":{"type":"string","description":""},"remoteShortInterfaceName":{"type":"string","description":""},"remoteMacAddress":{"type":"string","description":""},"remoteDeviceName":{"type":"string","description":""},"remotePlatform":{"type":"string","description":""},"remoteVersion":{"type":"string","description":""}}},"description":""},"lastSyncTime":{"type":"number","description":""},"ipInterfaces":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":""},"macAddress":{"type":"string","description":""},"ipv4Address":{"type":"object","properties":{},"description":""},"ipv6AddressList":{"type":"array","items":{"type":"object","properties":{}},"description":""},"name":{"type":"string","description":""}}},"description":""},"hostname":{"type":"string","description":""},"authStatus":{"type":"string","description":""},"stackInfo":{"type":"object","properties":{"supportsStackWorkflows":{"type":"boolean","description":""},"isFullRing":{"type":"boolean","description":""},"stackMemberList":{"type":"array","items":{"type":"object","properties":{"serialNumber":{"type":"string","description":""},"state":{"type":"string","description":""},"role":{"type":"string","description":""},"macAddress":{"type":"string","description":""},"pid":{"type":"string","description":""},"licenseLevel":{"type":"string","description":""},"licenseType":{"type":"string","description":""},"sudiSerialNumber":{"type":"string","description":""},"hardwareVersion":{"type":"string","description":""},"stackNumber":{"type":"number","description":""},"softwareVersion":{"type":"string","description":""},"priority":{"type":"number","description":""}}},"description":""},"stackRingProtocol":{"type":"string","description":""},"validLicenseLevels":{"type":"array","items":{"type":"string"},"description":""},"totalMemberCount":{"type":"number","description":""}},"description":""},"reloadRequested":{"type":"boolean","description":""},"addedOn":{"type":"number","description":""},"siteId":{"type":"string","description":""},"aaaCredentials":{"type":"object","properties":{"password":{"type":"string","description":""},"username":{"type":"string","description":""}},"description":""},"userMicNumbers":{"type":"array","items":{"type":"string"},"description":""},"userSudiSerialNos":{"type":"array","items":{"type":"string"},"description":""},"addnMacAddrs":{"type":"array","items":{"type":"string"},"description":""},"preWorkflowCliOuputs":{"type":"array","items":{"type":"object","properties":{"cli":{"type":"string","description":""},"cliOutput":{"type":"string","description":""}}},"description":""},"tags":{"type":"object","properties":{},"description":""},"sudiRequired":{"type":"boolean","description":""},"smartAccountId":{"type":"string","description":""},"virtualAccountId":{"type":"string","description":""},"populateInventory":{"type":"boolean","description":""},"siteName":{"type":"string","description":""},"name":{"type":"string","description":""}},"description":""},"systemResetWorkflow":{"type":"object","properties":{"_id":{"type":"string","description":""},"state":{"type":"string","description":""},"type":{"type":"string","description":""},"description":{"type":"string","description":""},"lastupdateOn":{"type":"number","description":""},"imageId":{"type":"string","description":""},"currTaskIdx":{"type":"number","description":""},"addedOn":{"type":"number","description":""},"tasks":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string","description":""},"type":{"type":"string","description":""},"currWorkItemIdx":{"type":"number","description":""},"taskSeqNo":{"type":"number","description":""},"endTime":{"type":"number","description":""},"startTime":{"type":"number","description":""},"workItemList":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string","description":""},"command":{"type":"string","description":""},"outputStr":{"type":"string","description":""},"endTime":{"type":"number","description":""},"startTime":{"type":"number","description":""},"timeTaken":{"type":"number","description":""}}},"description":""},"timeTaken":{"type":"number","description":""},"name":{"type":"string","description":""}}},"description":""},"addToInventory":{"type":"boolean","description":""},"instanceType":{"type":"string","description":""},"endTime":{"type":"number","description":""},"execTime":{"type":"number","description":""},"startTime":{"type":"number","description":""},"useState":{"type":"string","description":""},"configId":{"type":"string","description":""},"name":{"type":"string","description":""},"version":{"type":"number","description":""},"tenantId":{"type":"string","description":""}},"description":""},"systemWorkflow":{"type":"object","properties":{"_id":{"type":"string","description":""},"state":{"type":"string","description":""},"type":{"type":"string","description":""},"description":{"type":"string","description":""},"lastupdateOn":{"type":"number","description":""},"imageId":{"type":"string","description":""},"currTaskIdx":{"type":"number","description":""},"addedOn":{"type":"number","description":""},"tasks":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string","description":""},"type":{"type":"string","description":""},"currWorkItemIdx":{"type":"number","description":""},"taskSeqNo":{"type":"number","description":""},"endTime":{"type":"number","description":""},"startTime":{"type":"number","description":""},"workItemList":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string","description":""},"command":{"type":"string","description":""},"outputStr":{"type":"string","description":""},"endTime":{"type":"number","description":""},"startTime":{"type":"number","description":""},"timeTaken":{"type":"number","description":""}}},"description":""},"timeTaken":{"type":"number","description":""},"name":{"type":"string","description":""}}},"description":""},"addToInventory":{"type":"boolean","description":""},"instanceType":{"type":"string","description":""},"endTime":{"type":"number","description":""},"execTime":{"type":"number","description":""},"startTime":{"type":"number","description":""},"useState":{"type":"string","description":""},"configId":{"type":"string","description":""},"name":{"type":"string","description":""},"version":{"type":"number","description":""},"tenantId":{"type":"string","description":""}},"description":""},"workflow":{"type":"object","properties":{"_id":{"type":"string","description":""},"state":{"type":"string","description":""},"type":{"type":"string","description":""},"description":{"type":"string","description":""},"lastupdateOn":{"type":"number","description":""},"imageId":{"type":"string","description":""},"currTaskIdx":{"type":"number","description":""},"addedOn":{"type":"number","description":""},"tasks":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string","description":""},"type":{"type":"string","description":""},"currWorkItemIdx":{"type":"number","description":""},"taskSeqNo":{"type":"number","description":""},"endTime":{"type":"number","description":""},"startTime":{"type":"number","description":""},"workItemList":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string","description":""},"command":{"type":"string","description":""},"outputStr":{"type":"string","description":""},"endTime":{"type":"number","description":""},"startTime":{"type":"number","description":""},"timeTaken":{"type":"number","description":""}}},"description":""},"timeTaken":{"type":"number","description":""},"name":{"type":"string","description":""}}},"description":""},"addToInventory":{"type":"boolean","description":""},"instanceType":{"type":"string","description":""},"endTime":{"type":"number","description":""},"execTime":{"type":"number","description":""},"startTime":{"type":"number","description":""},"useState":{"type":"string","description":""},"configId":{"type":"string","description":""},"name":{"type":"string","description":""},"version":{"type":"number","description":""},"tenantId":{"type":"string","description":""}},"description":""},"runSummaryList":{"type":"array","items":{"type":"object","properties":{"details":{"type":"string","description":""},"historyTaskInfo":{"type":"object","properties":{"type":{"type":"string","description":""},"workItemList":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string","description":""},"command":{"type":"string","description":""},"outputStr":{"type":"string","description":""},"endTime":{"type":"number","description":""},"startTime":{"type":"number","description":""},"timeTaken":{"type":"number","description":""}}},"description":""},"timeTaken":{"type":"number","description":""},"addnDetails":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":""},"value":{"type":"string","description":""}}},"description":""},"name":{"type":"string","description":""}},"description":""},"errorFlag":{"type":"boolean","description":""},"timestamp":{"type":"number","description":""}}},"description":""},"workflowParameters":{"type":"object","properties":{"topOfStackSerialNumber":{"type":"string","description":""},"licenseLevel":{"type":"string","description":""},"licenseType":{"type":"string","description":""},"configList":{"type":"array","items":{"type":"object","properties":{"configParameters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":""},"value":{"type":"string","description":""}}},"description":""},"configId":{"type":"string","description":""}}},"description":""}},"description":""},"dayZeroConfig":{"type":"object","properties":{"config":{"type":"string","description":""}},"description":""},"dayZeroConfigPreview":{"type":"object","properties":{},"description":""},"version":{"type":"number","description":""},"tenantId":{"type":"string","description":""}}},"description":""},"failureList":{"type":"array","items":{"type":"object","properties":{"index":{"type":"number","description":""},"serialNum":{"type":"string","description":""},"id":{"type":"string","description":""},"msg":{"type":"string","description":""}}},"description":""}},"description":"","$$ref":"#/components/schemas/ImportDevicesInBulkResponse"}}}},"201":{"description":"The POST/PUT request was fulfilled and a new resource has been created. Information about the resource is in the response body.","content":{}},"202":{"description":"The request was accepted for processing, but the processing has not been completed.","content":{}},"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":"21a6-db25-4029-8f55","x-rapi-overview":"Add devices to PnP in bulk","x-rapi-domain":"Site Management","x-rapi-subdomain":"Device Onboarding (PnP)","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/onboarding/pnp-device/import","x-rapi-publicPath":"/dna/intent/api/v1/onboarding/pnp-device/import","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"__originalOperationId":"importDevicesInBulk","method":"post","path":"/dna/intent/api/v1/onboarding/pnp-device/import"}}