{"type":"api","title":"Rogue Additional Details","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":"rogueAdditionalDetails","tags":["Devices"],"deprecated":false,"summary":"Rogue Additional Details","description":"This API provides additional information of the rogue threats with details at BSSID level. The additional information includes Switch Port details in case of Rogue on Wire, first time when the rogue is seen in the network etc.","parameters":[],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"object","properties":{"offset":{"type":"number","description":"The offset of the first item in the collection to return. Default value is 1"},"limit":{"type":"number","description":"The maximum number of entries to return. Default value is 1000"},"startTime":{"type":"number","description":"This is the epoch start time in milliseconds from which data need to be fetched. Default value is 24 hours earlier to endTime"},"endTime":{"type":"number","description":"This is the epoch end time in milliseconds upto which data need to be fetched. Default value is current time"},"siteId":{"type":"array","items":{"type":"string"},"description":"Filter Rogues by location. Site IDs information can be fetched from \"Get Site\" API"},"threatLevel":{"type":"array","items":{"type":"string"},"description":"Filter Rogues by Threat Level. Threat Level information can be fetched from \"Get Threat Levels\" API"},"threatType":{"type":"array","items":{"type":"string"},"description":"Filter Rogues by Threat Type. Threat Type information can be fetched from \"Get Threat Types\" API"}},"description":"","$$ref":"#/components/schemas/RogueAdditionalDetailsRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"macAddress":{"type":"string","description":"MAC Address of the Rogue BSSID"},"mldMacAddress":{"type":"string","description":"MLD MAC Address of the Rogue BSSID, this is applicable only for Wi-Fi 7 Rogues"},"updatedTime":{"type":"integer","description":"Last time when the Rogue is seen in the network"},"createdTime":{"type":"integer","description":"First time when the Rogue is seen in the network"},"threatType":{"type":"string","description":"Type of the Rogue Threat"},"threatLevel":{"type":"string","description":"Level of the Rogue Threat"},"apName":{"type":"string","description":"Detecting AP Name"},"detectingAPMac":{"type":"string","description":"MAC Address of the Detecting AP"},"ssid":{"type":"string","description":"Rogue SSID"},"containment":{"type":"string","description":"Containment Status of the Rogue"},"radioType":{"type":"string","description":"Radio Type on which Rogue is detected"},"controllerIp":{"type":"string","description":"IP Address of the Controller detecting this Rogue"},"controllerName":{"type":"string","description":"Name of the Controller detecting this Rogue"},"channelNumber":{"type":"string","description":"Channel Number on which the Rogue is detected"},"siteNameHierarchy":{"type":"string","description":"Site Hierarchy of the Rogue"},"encryption":{"type":"string","description":"Security status of the Rogue SSID"},"switchIp":{"type":"string","description":"IP Address of the Switch on which the Rogue is connected. This will be filled only in case of Rogue on Wire Threat Type "},"switchName":{"type":"string","description":"Name of the Switch on which the Rogue is connected. This will be filled only in case of Rogue on Wire Threat Type "},"portDescription":{"type":"string","description":"Port information of the Switch on which the Rogue is connected. This will be filled only in case of Rogue on Wire Threat Type "}}},"description":""},"totalCount":{"type":"integer","description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/RogueAdditionalDetailsResponse"}}}},"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":{}},"500":{"description":"Internal Server Error","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":"659c-e9bd-403a-8de6","x-rapi-overview":"This API provides additional information of the rogue threats with details at BSSID level. The additional information includes Switch Port details in case of Rogue on Wire, first time when the rogue is seen in the network etc.","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Devices","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/assurance/v1/rogue-service/api/rogueBssidDetail","x-rapi-publicPath":"/dna/intent/api/v1/security/rogue/additional/details","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"50~MINUTE","__originalOperationId":"rogueAdditionalDetails","method":"post","path":"/dna/intent/api/v1/security/rogue/additional/details"}}