{"type":"api","title":"Update device credential settings for a site","meta":{"id":"/apps/pubhub/media/cisco-dna-center-api-2-3-7/cfd5b603aed2287d655a303aa675cd87535c542b/dbf2de2b-cd1c-3bea-8b53-7a764448a2d6","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7","version":"2.3.7"},"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":"updateDeviceCredentialSettingsForASite_","tags":["Network Settings"],"summary":"Update device credential settings for a site.","description":"Updates device credential settings for a site; `null` values indicate that the setting will be inherited from the parent site; empty objects (`{}`) indicate that the credential is unset, and that no credential of that type will be used for the site.","parameters":[{"name":"Content-Type","description":"Request body content type","required":true,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"id","description":"Site Id, retrievable from the `id` attribute in `/dna/intent/api/v1/sites`","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"}],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"object","properties":{"cliCredentialsId":{"type":"object","properties":{"credentialsId":{"type":"string","description":"The `id` of the credentials."}},"required":["credentialsId"],"description":"CLI credentials used to access devices assigned to the site."},"snmpv2cReadCredentialsId":{"type":"object","properties":{"credentialsId":{"type":"string","description":"The `id` of the credentials."}},"required":["credentialsId"],"description":"SNMPv2c Read credentials used to access devices assigned to the site."},"snmpv2cWriteCredentialsId":{"type":"object","properties":{"credentialsId":{"type":"string","description":"The `id` of the credentials."}},"required":["credentialsId"],"description":"SNMPv2c Write credentials used to access devices assigned to the site."},"snmpv3CredentialsId":{"type":"object","properties":{"credentialsId":{"type":"string","description":"The `id` of the credentials."}},"required":["credentialsId"],"description":"SNMPv3 credentials used to access devices assigned to the site."},"httpReadCredentialsId":{"type":"object","properties":{"credentialsId":{"type":"string","description":"The `id` of the credentials."}},"required":["credentialsId"],"description":"HTTP(S) Read credentials used to access devices assigned to the site."},"httpWriteCredentialsId":{"type":"object","properties":{"credentialsId":{"type":"string","description":"The `id` of the credentials."}},"required":["credentialsId"],"description":"HTTP(S) Write credentials used to access devices assigned to the site."}},"required":["cliCredentialsId","snmpv2cReadCredentialsId","snmpv2cWriteCredentialsId","snmpv3CredentialsId","httpReadCredentialsId","httpWriteCredentialsId"],"description":"","$$ref":"#/components/schemas/DeviceCredentialSettings"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string","description":"Response Version e.g. : 1.0"},"response":{"type":"object","properties":{"url":{"type":"string","description":"URL to get task details e.g. : /api/v1/task/3200a44a-9186-4caf-8c32-419cd1f3d3f5"},"taskId":{"type":"string","description":"Task Id in uuid format. e.g. : 3200a44a-9186-4caf-8c32-419cd1f3d3f5 "}},"required":["url","taskId"],"description":"Response containing task id in uuid format."}},"required":["version","response"],"description":"Task Id Result","$$ref":"#/components/schemas/TaskResponse"}}}},"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":{}},"502":{"description":"The server is (temporarily) unavailable.","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":"5aa0-6949-4dfa-bec5","x-rapi-overview":"Updates device credential settings for a site; `null` values indicate that the setting will be inherited from the parent site; empty objects (`{}`) indicate that the credential is unset, and that no credential of that type will be used for the site.","x-rapi-domain":"Site Management","x-rapi-subdomain":"Network Settings","x-rapi-version":"1.0.0","x-rapi-internalPath":"/intent/api/v1/sites/${id}/deviceCredentials","x-rapi-publicPath":"/dna/intent/api/v1/sites/${id}/deviceCredentials","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"50~MINUTE","__originalOperationId":"updateDeviceCredentialSettingsForASite.","method":"put","path":"/dna/intent/api/v1/sites/{id}/deviceCredentials"}}