Cisco Catalyst Center Clients API is one of 30 APIs that Cisco Catalyst Center publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Clients. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.
This API exposes
9 operations
across 9 paths,
and defines 85 schemas.
It is described by OpenAPI 3.2.0, at version 3.2.3.
Requests are made against a single base URL, https://developer.cisco.com.
The identity and technical contract details declared by the specification.
name
string
Host name of the network entity such as Client or Network Device
CommonHealthKpi
object
3 properties
WiredTrafficStats
object
Traffic statistics specific for wired client
6 properties
ClientsSummaryGroupsResponse
object
Clients Summary response contains attributes, aggregateAttributes and groups attributes, aggregatedAttributes and groups are mutually exclusive. If user reques…
3 properties
Client
object
Assurance Network Client details
6 properties
CountIntegerResponse_response
object
1 property
ApMode
string
Access Point operating mode
vnId
string
Virtual network identifier assigned to wired client
ErrorObject
object
Error object containing error code and information about the error
3 properties
WirelessHealthKpi
object
8 properties
ErrorResponse
object
Contains information explaining the error that occured processing this request.
2 properties
AnalyticsAttributesResponse
array
connectedDeviceId
string
UUID of the neighbor network device that client or network device is connected to
AnalyticsAttributeResponse
object
2 properties
Channel
string
Specific WiFi frequency that client uses to send or receive data from Access Point
ClientFilterObj
object
5 properties
WlcId
string
UUID of the Wireless Controller that reports the wireless client
SortByObj
object
This is a unified sortBy model for attributes and aggregate attributes request. If function is specified then API will sort the colllection on aggregated attri…
3 properties
OnboardingDetail
object
27 properties
LogicalOperator
string
Operator to use when attempting to apply a logical conjunction of more than 1 filter Logical operations include: 'and', 'or'.
PaginationWithAggregate
object
5 properties
WirelessLatencyStats
object
Wireless latency is measured by the time it takes for a packet to be successfully transmitted from an AP to the client
4 properties
PaginationTrend
object
4 properties
ClientBasic
object
Basic information about the client
3 properties
ClientAggregateAttribute
object
Field name and list of aggregate functions to be applied when querying the data.
2 properties
WirelessConnectionDetail
object
Connection attributes specific for wireless clients
22 properties
ClientWithAggregateResponse
object
1 property
siteHierarchy
string
The full hierarchy breakdown of the site tree in name form starting from Global site name and ending with the specific site site. 'Global' is the Root name of…
ClientTrendQueryRequest
object
Request payload used for complex trend query API. It contains | 'trend' 'attributes' - To provide the list of fields that user is interested in the response. |…
8 properties
1 required
connectedDeviceName
string
Name of the neighbor network device that client or network device is connected to
ApEthernetMac
string
Ethernet Mac Address of the Access Point the wireless client is connected to
ClientAggregateAttributesResponse
array
trendInterval
string
The time window to aggregate the metrics. Interval can be 5 minutes or 10 minutes or 1 hour or 1 day or 7 days
ApMac
string
Access Point's base radio mac addresss where the wireless client is connected
ClientGroupByField
string
Supported groupBy attributes related to clients
WiredConnectionDetail
object
Connection attributes specific for wired clients
6 properties
ClientFilterField
string
Supported filter attributes related to clients
ClientAggregateField
string
Supported aggregated attributes related to clients | Aggregate Function | Supported Aggregate Fields | | --- | --- | | min | overallScore, onboardingScore, con…
WiredHealthKpi
object
6 properties
CountIntegerResponse
object
Reports
2 properties
ClientsResponseModel
object
Collection of Clients response model
3 properties
ClientAttribute
string
Attributes related to clients resource that can be requested to only be part of the response along with the required attributes.
ClientAggregateAttributes
array
ClientsQueryRequest
object
Request payload used for complex query API.
7 properties
ChannelWidth
string
Is the channel bandwidth used by the radio for WiFi communication.
Ssid
string
SSID is the name of wireless network to which clientconnects to. It is also referred to as WLAN ID - Wireless Local Area Network Identifier
vlanId
string
VLAN identifier assigned to wired or wireless client
Function
string
Type of aggregate function to apply on the field when querying data
ClientViews
array
View is predefined set of attributes supported by the API. The attributes related to view only will be part of the API response along with required fields. If…
Protocol
string
802.11 protocol type used by wireless client to connect to Access Point
ClientsQueryCountRequest
object
Request payload used for complex query count API.
3 properties
ClientFilters
array
List of filters to apply when querying the data Filtering on numerical fields (integer, number,etc.) will support the numerical operators: [eq, lt, gt, lte, gt…
ClientsSummaryRequest
object
Request payload used for summary query API. It contains
7 properties
CommonConnectedNetworkDeviceDetail
object
Connected network device attributes common for wired and wireless clients
5 properties
Operator
string
Type of filter operator to use for querying data | in and out operator takes multiple values and applies the filters
RadioId
integer
Radio slot Id of the Access Point where the wireless client is connected
endTime
integer
End time to which the API queries the dataset related to the resource. It must be specified in terms of milliseconds since UNIX epoch. Value is inclusive.
ClientTrendResponse
object
3 properties
ClientsSummaryResponse
object
3 properties
WirelessTrafficStats
object
Traffic statistics specific for wireless client
6 properties
CommonDetail
object
Client detail information common for wired and wireless
18 properties
L2Vn
string
L2 Virtual network name assigned to wired client
topN
integer
Number of records to retrieve
L3Vn
string
L3 Virtual network name assigned to wired client
ClientAggregateAttributeResponse
object
3 properties
ClientsTopNResponse
object
3 properties
connectedInterfaceName
string
Neighbor network device interface where wired client or network device is connected to
ProtocolCapability
string
Highest protocol supported by the wireless client
ClientsTrendGroupsResponse
object
The aggregate trend response includes timestamp, attributes, aggregateAttributes, and group attributes. The attributes aggregateAttributes and groups are mutua…
4 properties
WlcName
string
Wireless Controller name that reports the wireless client
MacAddress
string
Mac Address of the Client
ClientResponseModel
object
A single Client response model
2 properties
CommonConnectionDetail
object
Client Connection attributes common for wired and wireless clients
2 properties
ClientsTopNRequest
object
Request payload used for Top-N query API. It contains
8 properties
2 required
ClientGroupByAttributes
array
ClientsGroupResponse
object
3 properties
startTime
integer
Start time from which the API queries the dataset related to the resource. It must be specified in terms of milliseconds since UNIX epoch. Value is inclusive.
ClientsWithAggregateResponseModel
object
Collection of Clients response model
3 properties
CommonTrafficStats
object
Traffic statistics common for wired and wireless clients
7 properties
WiredConnectedNetworkDeviceDetail
object
Connected network device attributes specific for wired clients
3 properties
siteHierarchyId
string
The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Cisco Catalyst Center publishes across the network.
