Cisco Catalyst Center Energy 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 Energy. 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
19 operations
across 17 paths,
and defines 73 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.1.
Requests are made against a single base URL, https://developer.cisco.com/data/api/v1.
The identity and technical contract details declared by the specification.
NetworkDeviceEnergyAttribute
string
Field names which are supported by this API as attributes.
SiteEnergyAggregateAttributesResponse
array
SitesEnergyResponse
object
3 properties
CountIntegerResponse_response
object
1 property
ClientDeviceEnergyResponse
object
2 properties
SiteEnergyAggregateAttributeKey
string
Field name on which the aggregate function should be applied when querying the data. The fields supported for aggregation in the API response object are, [ener…
SiteEnergyView
string
Views which are supported by this API. Each view represents a specific data set. Response data provided by each view: 1. Site [id, siteHierarchy, siteHierarchy…
ErrorObject
object
3 properties
DeviceEnergySortByObj
object
This is a unified sortBy model for attributes and aggregate attributes request. If function is specified then API will sort the collection on aggregated attrib…
3 properties
ClientDevicesEnergyResponse
object
3 properties
ErrorResponse
object
Contains information explaining the error that occured processing this request.
2 properties
ClientDevicesEnergyQueryResponse
object
3 properties
startAndEndTime
object
start and end time of data set to query. Data is aggregated based on time window and timestamped with window start time. | For example - 1. When data events fa…
2 properties
NetworkDeviceEnergySortByObj
object
This is a unified sortBy model for attributes and aggregate attributes request. If function is specified then API will sort the collection on aggregated attrib…
3 properties
NetworkDeviceEnergyResponse
object
2 properties
ClientDeviceEnergy
object
Assurance Client Device Energy Summaries details
3 properties
DevicesEnergyAggregateAttribute
object
Aggregate attribute object for device energy summaries. Name and function supported are in their respective enum objects.
2 properties
DeviceEnergySummaryAnalyticsResponse
object
3 properties
NetworkDeviceEnergyFilter
object
In case of single filter, please use key, operator and value combination. If multiple filters need to be applied using a logical operation, please use logicalO…
5 properties
DeviceEnergyAttributesResponse_inner
object
2 properties
DeviceEnergy
object
Assurance Device Energy Summaries details
22 properties
DeviceEnergySummaryAnalyticsRequest
object
Request object for device summary analytics.
5 properties
NetworkDevicesEnergyQueryResponse
object
3 properties
LogicalOperator
string
Operator to use when attempting to apply a logical conjunction of more than 1 filter Logical operations include: 'and', 'or'.
ClientDeviceEnergyFilters
array
List of filters to apply when querying the device energy data. Supported operators are [in, eq, like]
SiteEnergyFilter
object
In case of single filter, please use key, operator and value combination. If multiple filters need to be applied using a logical operation, please use logicalO…
5 properties
DeviceEnergyFilters
array
List of filters to apply when querying the device energy data. Supported operators are [in, eq, like]
DeviceEnergyFilterKey
string
Field names which are supported by this API for filter keys.
ClientDeviceEnergyPaginationWithAggregateSortBy
object
Pagination model with support for aggregate sort by.
4 properties
NetworkDeviceEnergyPaginationWithAggregateSortBy
object
Pagination model with support for aggregate sort by.
4 properties
DeviceEnergyResponse_groups
object
3 properties
DeviceEnergyTrendInterval
string
The time window to aggregate the metrics. Interval can be 1 hour or 1 day.
SiteEnergyResponse
object
2 properties
DeviceEnergyPaginationWithAggregateSortBy
object
Pagination model with support for aggregate sort by.
4 properties
NetworkDeviceEnergyFilters
array
List of filters to apply when querying the device energy data. Supported operators are [in, eq, like]
DeviceEnergyTrendAnalyticsResponse
object
3 properties
DeviceEnergyResponse
object
Response object for device summary analytics.
3 properties
SitesEnergyQueryRequest
object
5 properties
asyncInfoContainer
object
Generic model that will contain the asynchronous task/process information
2 properties
SitesEnergyQueryResponse
object
3 properties
DeviceEnergyAttribute
string
Field names which are supported by this API as attributes.
asyncInfo
object
Generic model with information on the asynchronous task/process that was created to handle an API request
2 properties
NetworkDeviceEnergy
object
Assurance Network Device Energy Summaries details
1 property
CountIntegerResponse
object
Reports
2 properties
SiteEnergyFilters
array
List of filters to apply when querying the site energy data. Supported operators are [in, eq, like]
SiteEnergyAggregateAttribute
object
2 properties
ClientDeviceEnergyFilter
object
In case of single filter, please use key, operator and value combination. If multiple filters need to be applied using a logical operation, please use logicalO…
5 properties
Function
string
Type of aggregate function to apply on the field when querying data
ClientDeviceEnergyQueryRequest
object
Request object for device energy summaries query request.
5 properties
DeviceEnergyAttributesResponse
array
Response object for device summary analytics attributes.
TrendPaginationResponse
object
Pagination response object for trend analytics.
4 properties
SiteEnergy
object
Assurance site and corresponding energy details
13 properties
ClientDeviceEnergyAttribute
string
Field names which are supported by this API as attributes.
DeviceEnergyGroupBy
array
List of group by supported. GroupBy should be in a specific sequence ex - deviceCategory, deviceSubCategory and not deviceSubCategory, deviceCategory
SiteEnergyAttribute
string
Field names which are supported by this API as attributes or filter keys
ClientDeviceEnergySortByObj
object
This is a unified sortBy model for attributes and aggregate attributes request. If function is specified then API will sort the collection on aggregated attrib…
3 properties
Operator
string
Type of filter operator to use for querying data | in and out operator takes multiple values and applies the filters
DeviceEnergyAggregateAttributesResponse_inner
object
3 properties
DeviceEnergyAggregateAttributeKey
string
Field name on which the aggregate function should be applied when querying the data. The fields supported for aggregation in the API response object are, [ener…
NetworkDevicesEnergyResponse
object
3 properties
SiteEnergySortByObj
object
This is a unified sortBy model for attributes and aggregate attributes request. If function is specified then API will sort the collection on aggregated attrib…
3 properties
DeviceEnergyAggregateAttributesResponse
array
Response object for device energy aggregate attributes.
ClientDeviceEnergyView
string
Views which are supported by this API. Each view represents a specific data set. Response data provided by each view: 1. device [id, deviceId, deviceCategory,…
SiteEnergyPaginationWithAggregateSortBy
object
Pagination model with support for aggregate sort by.
4 properties
NetworkDeviceEnergyView
string
Views which are supported by this API. Each view represents a specific data set. Response data provided by each view: 1. device [id, deviceId, deviceCategory,…
SiteEnergyFilterKey
string
Field names which are supported by this API for filter keys.
DeviceEnergyFilter
object
In case of single filter, please use key, operator and value combination. If multiple filters need to be applied using a logical operation, please use logicalO…
5 properties
ClientDeviceEnergyFilterKey
string
Field names which are supported by this API for filter keys.
NetworkDeviceEnergyFilterKey
string
Field names which are supported by this API for filter keys.
TrendPaginationRequest
object
Pagination request object for trend analytics.
3 properties
NetworkDeviceEnergyQueryRequest
object
Request object for device energy summaries query request.
5 properties
SiteEnergyAggregateAttributesResponse_inner
object
3 properties
DeviceEnergyTrendAnalyticsRequest
object
Request object for device energy summaries trend analytics.
6 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Cisco Catalyst Center publishes across the network.