{"type":"api","title":"Updates an existing discovery by specified Id","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/b3d6cc9fb9f506b3bc9099912aa8a6f9d87e0f0a/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":"updatesAnExistingDiscoveryBySpecifiedId","tags":["Discovery"],"deprecated":false,"summary":"Updates an existing discovery by specified Id","description":"Stops or starts an existing discovery","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":"object","properties":{"attributeInfo":{"type":"object","properties":{},"description":"Deprecated"},"cdpLevel":{"type":"integer","description":"CDP level to which neighbor devices to be discovered"},"deviceIds":{"type":"string","description":"Ids of the devices discovered in a discovery"},"discoveryCondition":{"type":"string","description":"To indicate the discovery status. Available options: Complete or In Progress"},"discoveryStatus":{"type":"string","description":"Status of the discovery. Available options are: Active, Inactive, Edit"},"discoveryType":{"type":"string","description":"Type of the discovery. 'Single', 'Range', 'Multi Range', 'CDP', 'LLDP', 'CIDR'"},"enablePasswordList":{"type":"string","description":"Enable Password of the devices to be discovered"},"globalCredentialIdList":{"type":"array","items":{"type":"string"},"description":"List of global credential ids to be used"},"httpReadCredential":{"type":"object","properties":{"comments":{"type":"string","description":"Comments to identify the credential"},"credentialType":{"type":"string","enum":["GLOBAL","APP"],"description":"Credential type to identify the application that uses the credential"},"description":{"type":"string","description":"Description of the credential"},"id":{"type":"string","description":"Credential Id"},"instanceTenantId":{"type":"string","description":"Credential Tenant Id"},"instanceUuid":{"type":"string","description":"Credential Id"},"password":{"type":"string","description":"HTTP(S) password"},"port":{"type":"integer","description":"HTTP(S) port"},"secure":{"type":"boolean","description":"Flag for HTTPS"},"username":{"type":"string","description":"HTTP(S) username"}},"description":"HTTP Read Credential of the devices to be discovered"},"httpWriteCredential":{"type":"object","properties":{"comments":{"type":"string","description":"Comments to identify the credential"},"credentialType":{"type":"string","enum":["GLOBAL","APP"],"description":"Credential type to identify the application that uses the credential"},"description":{"type":"string","description":"Description of the credential"},"id":{"type":"string","description":"Credential Id"},"instanceTenantId":{"type":"string","description":"Credential Tenant Id"},"instanceUuid":{"type":"string","description":"Credential Id"},"password":{"type":"string","description":"HTTP(S) password"},"port":{"type":"integer","description":"HTTP(S) port"},"secure":{"type":"boolean","description":"Flag for HTTPS"},"username":{"type":"string","description":"HTTP(S) username"}},"description":"HTTP Write Credential of the devices to be discovered"},"id":{"type":"string","description":"Unique Discovery Id"},"ipAddressList":{"type":"string","description":"List of IP address of the devices to be discovered"},"ipFilterList":{"type":"string","description":"IP addresses of the devices to be filtered"},"isAutoCdp":{"type":"boolean","description":"Flag to mention if CDP discovery or not"},"lldpLevel":{"type":"integer","description":"LLDP level to which neighbor devices to be discovered"},"name":{"type":"string","description":"Name for the discovery"},"netconfPort":{"type":"string","description":"Netconf port on the device. Netconf will need valid sshv2 credentials for it to work"},"numDevices":{"type":"integer","description":"Number of devices discovered in the discovery"},"parentDiscoveryId":{"type":"string","description":"Parent Discovery Id from which the discovery was initiated"},"passwordList":{"type":"string","description":"Password of the devices to be discovered"},"preferredMgmtIPMethod":{"type":"string","description":"Preferred management IP method. Available options are 'None' and 'UseLoopBack'"},"protocolOrder":{"type":"string","description":"Order of protocol (ssh/telnet) in which device connection will be tried. Ex: 'telnet': only telnet; 'ssh,telnet': ssh with higher order than telnet"},"retryCount":{"type":"integer","description":"Number of times to try establishing connection to device"},"snmpAuthPassphrase":{"type":"string","description":"Auth passphrase for SNMP"},"snmpAuthProtocol":{"type":"string","description":"SNMP auth protocol. SHA' or 'MD5'"},"snmpMode":{"type":"string","description":"Mode of SNMP. 'AUTHPRIV' or 'AUTHNOPRIV' or 'NOAUTHNOPRIV'"},"snmpPrivPassphrase":{"type":"string","description":"Passphrase for SNMP privacy"},"snmpPrivProtocol":{"type":"string","description":"SNMP privacy protocol. 'AES128'"},"snmpRoCommunity":{"type":"string","description":"SNMP RO community of the devices to be discovered"},"snmpRoCommunityDesc":{"type":"string","description":"Description for SNMP RO community"},"snmpRwCommunity":{"type":"string","description":"SNMP RW community of the devices to be discovered"},"snmpRwCommunityDesc":{"type":"string","description":"Description for SNMP RW community"},"snmpUserName":{"type":"string","description":"SNMP username of the device"},"timeOut":{"type":"integer","description":"Time to wait for device response."},"updateMgmtIp":{"type":"boolean","description":"Updates Management IP if multiple IPs are available for a device. If set to true, when a device is rediscovered with a different IP, the management IP is updated. Default value is false"},"userNameList":{"type":"string","description":"Username of the devices to be discovered"}},"description":"","$$ref":"#/components/schemas/UpdatesAnExistingDiscoveryBySpecifiedIdRequest"}}},"required":true},"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"taskId":{"type":"string","description":""},"url":{"type":"string","description":""}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/UpdatesAnExistingDiscoveryBySpecifiedIdResponse"}}}},"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":"9788-b8fc-4418-831d","x-rapi-overview":"Stops or starts an existing discovery","x-rapi-domain":"Operational Tasks","x-rapi-subdomain":"Discovery","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/discovery","x-rapi-publicPath":"/dna/intent/api/v1/discovery","x-rapi-registerInKONG":true,"x-rapi-banner":[],"__originalOperationId":"updatesAnExistingDiscoveryBySpecifiedId","method":"put","path":"/dna/intent/api/v1/discovery"}}