{"type":"api","title":"Create Device Credentials","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":"createDeviceCredentials","tags":["Network Settings"],"deprecated":false,"summary":"Create Device Credentials","description":"API to create device credentials.","parameters":[],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"object","properties":{"settings":{"type":"object","properties":{"cliCredential":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Name or description for CLI credential"},"username":{"type":"string","description":"User name for CLI credential"},"password":{"type":"string","description":"Password for CLI credential"},"enablePassword":{"type":"string","description":"Enable password for CLI credential"}}},"description":"Credential detail for CLI"},"snmpV2cRead":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description for snmp v2 read"},"readCommunity":{"type":"string","description":"Ready community for snmp v2 read credential"}}},"description":"Snmp v2 read credential detail"},"snmpV2cWrite":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description for snmp v2 write"},"writeCommunity":{"type":"string","description":"Write community for snmp v2 write credential"}}},"description":"Snmp v2 write credential detail"},"snmpV3":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Name or description for SNMPV3 credential"},"username":{"type":"string","description":"User name for SNMPv3 credential"},"privacyType":{"type":"string","enum":["AES128","DES"],"description":"Privacy type for snmpv3 credential"},"privacyPassword":{"type":"string","description":"Privacy password for snmpv3 credential"},"authType":{"type":"string","enum":["SHA","MD5"],"description":"Authentication type for snmpv3 credential"},"authPassword":{"type":"string","description":"Authentication password for snmpv3 credential"},"snmpMode":{"type":"string","enum":["AUTHPRIV","AUTHNOPRIV","NOAUTHNOPRIV"],"description":"Mode for snmpv3 credential"}}},"description":"Credential for SNMPv3"},"httpsRead":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name or description of http read credential"},"username":{"type":"string","description":"User name of the http read credential"},"password":{"type":"string","description":"Password for http read credential"},"port":{"type":"number","description":"Port for http read credential"}}},"description":"Http ready credential detail"},"httpsWrite":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name or description of http write credential"},"username":{"type":"string","description":"User name of the http write credential"},"password":{"type":"string","description":"Password for http write credential"},"port":{"type":"number","description":" Port for http write credential"}}},"description":"Http write credential detail"}},"description":""}},"description":"","$$ref":"#/components/schemas/CreateDeviceCredentialsRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"executionId":{"type":"string","description":""},"executionStatusUrl":{"type":"string","description":""},"message":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/CreateDeviceCredentialsResponse"}}}},"202":{"description":"The request has been accepted for execution.","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":"fbb9-5b37-484a-9fce","x-rapi-overview":"API to create device credentials.","x-rapi-domain":"Site Management","x-rapi-subdomain":"Network Settings","x-rapi-version":"1.0.0","x-rapi-banner":["Sunset"],"x-rapi-rateLimiting":"100~1","__originalOperationId":"createDeviceCredentials","method":"post","path":"/dna/intent/api/v1/device-credential"}}