How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cisco Catalyst Center Interface List API

The interfaceList API from Cisco Catalyst Center — 6 operation(s) for interfacelist.

Cisco Catalyst Center Interface List API is one of 30 APIs that Cisco Catalyst Center publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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 6 operations across 6 paths, and defines 44 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://developer.cisco.com/data/api/v1.

6 operations 6 paths 44 schemas 3 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://{catalyst-center-host}/dna/intent/api/v1
License
Terms of Service
Resource Areas
1

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 3 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

interfaceList 6
GET
/dna/data/api/v1/interfaces
Gets interfaces along with statistics data from all network devices.
readInterfaces 17 params → 2004005001XX2XX3XX4XX5XX
GET
/dna/data/api/v1/interfaces/{id}
Get the interface data for the given interface id (instance Uuid) along with the statistics and poe data
readInterfaceById 5 params → 2004005001XX2XX3XX4XX5XX
GET
/dna/data/api/v1/interfaces/count
Gets the total Network device interface counts in the specified time range. When there is no start and end time specified returns the latest interfaces total count.
readInterfacesCount 11 params → 2004005001XX2XX3XX4XX5XX
POST
/dna/data/api/v1/interfaces/query
Gets the list of interfaces across the Network Devices based on the provided complex filters and aggregation functions
queryInterfacesWithFilter body → 2004005001XX2XX3XX4XX5XX
POST
/dna/data/api/v1/interfaces/query/count
The Total interfaces count across the Network devices.
queryInterfaceCountWithFilter body → 2004005001XX2XX3XX4XX5XX
POST
/dna/data/api/v1/interfaces/{id}/trendAnalytics
The Trend analytcis data for the interfaces in the specified time range
readInterfaceTrendAnalytics 1 param body → 2004005001XX2XX3XX4XX5XX

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are InterfaceData (64 properties), InterfacesQueryRequest (5 properties), InterfacesAnalyticsFilter (5 properties), InterfacesFilter (5 properties). Each schema is shown below with its type and property counts.

InterfaceResponseAggregateAttributes
array
LogicalOperator
string
Operator to use when attempting to apply a logical conjunction of more than 1 filter Logical operations include: 'and', 'or'.
CountIntegerResponse
object
Reports
2 properties
InterfaceAggregateAttributes
array
InterfacesQueryRequest
object
5 properties
PaginationResponse
object
4 properties
AggregateResponseAttributes
object
2 properties
CountIntegerResponse_response
object
1 property
InterfaceAggregateAttribute
object
2 properties
Pagination
object
3 properties
InterfacesTrendAggregateName
string
Field name on which the aggregate function should be applied when querying the data. The supported field details are available in the enum definition. The foll…
Function
string
The name of the aggregate function
InterfacesAnalyticsFilter
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
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…
InterfaceTrendAttributesResponse
array
InterfacesFilters
array
InterfacesTrendAggregateAttributes
object
2 properties
InterfaceTrendAggregateResponse
object
3 properties
ErrorObject
object
3 properties
InterfaceTrendRequest
object
The input payload schema to query the Trend Analytics Interface data.
5 properties 1 required
InterfacesAnalyticsFilters
array
List of filters to apply when querying the Network devices data. Supported operators are [in, eq, neq, notIn, like]
InterfaceResponseAggregateAttribute
object
1 property
InterfacesTrendAttributes
string
The interface trend attributes. The following fields have set potential values. | Field | Functions Supported | | --- | --- | | poeOperStatus | OFF:POWERDENY,…
InterfacesAttributes
string
Field names which are supported by this API as attributes or filter keys
ErrorResponse
object
Contains information explaining the error that occured processing this request.
2 properties
PaginationResponse_sortBy
object
List of field names and corresponding order used to sort the records.
2 properties
InterfaceTrendAttributesResponse_inner
object
2 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
Pagination_sortBy
object
List of field names and corresponding order used to sort the records.
2 properties
InterfaceResponse
object
Interfaces Response model on success
2 properties
Operator
string
Type of filter operator to use for querying data | in and out operator takes multiple values and applies the filters
InterfacesViews
string
Views which are supported by this API. Each view represents a specific data set. Response data provided by each view: 1. configuration [id,name,adminStatus,des…
InterfaceWithAggregateResponse
object
Interface data with Aggregated value based on the data provided in the input payload.
1 property
AggregateResponseAttributes_values
object
2 properties
InterfacesQueryResponse
object
3 properties
InterfaceTrendResponse
object
3 properties
InterfaceData
object
Assurance Network Device interface details
64 properties
Function_1
string
Type of aggregate function to apply on the field when querying data
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.
InterfaceTrendResponseList
object
2 properties
InterfaceTrendAggregatesResponse
array
InterfacesFilter
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
InterfacesResponse
object
Interfaces Response model on success
3 properties
InterfaceAnalyticsAggregateName
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, [rxDi…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cisco-catalyst-center-interfacelist-api-openapi.yml Raw ↑

Other APIs Cisco Catalyst Center publishes across the network.

Cisco Catalyst Center MCP Server
Cisco Catalyst Center AAA Services API
Cisco Catalyst Center Application Health Score Definitions API
Cisco Catalyst Center Assurance Events API
Cisco Catalyst Center Assurance Tasks API
Cisco Catalyst Center Clients API
Cisco Catalyst Center Custom Issue Definitions API
Cisco Catalyst Center DHCP Services API
Cisco Catalyst Center Direct Deploy API
Cisco Catalyst Center DNS Services API
Cisco Catalyst Center Energy API
Cisco Catalyst Center Fabric Site Health Summaries API
Where this information came from

This is an independent, third-party profile of Cisco Catalyst Center Interface List API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.