{"type":"api","title":"Set Telemetry settings for a site","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":"setTelemetrySettingsForASite","tags":["Network Settings"],"deprecated":false,"summary":"Set Telemetry settings for a site","description":"Sets telemetry settings for the given site; `null` values indicate that the setting will be inherited from the parent 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":{"wiredDataCollection":{"type":"object","properties":{"enableWiredDataCollection":{"type":"boolean","description":"Track the presence, location, and movement of wired endpoints in the network. Traffic received from endpoints is used to extract and store their identity information (MAC address and IP address). Other features, such as IEEE 802.1X, web authentication, Cisco Security Groups (formerly TrustSec), SD-Access, and Assurance, depend on this identity information to operate properly. Wired Endpoint Data Collection enables Device Tracking policies on devices assigned to the Access role in Inventory."}},"description":""},"wirelessTelemetry":{"type":"object","properties":{"enableWirelessTelemetry":{"type":"boolean","description":"Enables Streaming Telemetry on your wireless controllers in order to determine the health of your wireless controller, access points and wireless clients."}},"description":""},"snmpTraps":{"type":"object","properties":{"useBuiltinTrapServer":{"type":"boolean","description":"Enable this server as a destination server for SNMP traps and messages from your network"},"externalTrapServers":{"type":"array","items":{"type":"string"},"description":"External SNMP trap servers. Example: [\"250.162.252.170\",\"2001:db8:3c4d:15::1a2f:1a2b\"]"}},"description":""},"syslogs":{"type":"object","properties":{"useBuiltinSyslogServer":{"type":"boolean","description":"Enable this server as a destination server for syslog messages."},"externalSyslogServers":{"type":"array","items":{"type":"string"},"description":"External syslog servers. Example: [\"250.162.252.170\", \"2001:db8:3c4d:15::1a2f:1a2b\"]"}},"description":""},"applicationVisibility":{"type":"object","properties":{"collector":{"type":"object","properties":{"collectorType":{"type":"string","enum":["Builtin","TelemetryBrokerOrUDPDirector"],"description":""},"address":{"type":"string","description":"IP Address. If collection type is 'TelemetryBrokerOrUDPDirector', this field value is mandatory otherwise it is optional. Examples: \"250.162.252.170\", \"2001:db8:3c4d:15::1a2f:1a2b\""},"port":{"type":"integer","description":"Min:1; Max: 65535. If collection type is 'TelemetryBrokerOrUDPDirector', this field value is mandatory otherwise it is optional."}},"description":""},"enableOnWiredAccessDevices":{"type":"boolean","description":"Enable Netflow Application Telemetry and Controller Based Application Recognition (CBAR) by default upon network device site assignment for wired access devices."}},"description":""}},"description":"","$$ref":"#/components/schemas/SetTelemetrySettingsForASiteRequest"}}},"required":true},"responses":{"200":{"description":"","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 "}},"description":"Response containing task id in uuid format."}},"description":"Task Id Result","$$ref":"#/components/schemas/SetTelemetrySettingsForASiteResponse"}}}},"202":{"description":"Accepted","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":{}},"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":"a5a1-6835-40ab-8d2f","x-rapi-overview":"Sets telemetry settings for the given site; `null` values indicate that the setting will be inherited from the parent 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}/telemetrySettings","x-rapi-publicPath":"/dna/intent/api/v1/sites/${id}/telemetrySettings","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"50~MINUTE","__originalOperationId":"setTelemetrySettingsForASite","method":"put","path":"/dna/intent/api/v1/sites/{id}/telemetrySettings"}}