openapi: 3.2.0
info:
title: Assurance Network Device Interfaces List with statistics data Interface List API
description: This API provides a comprehensive list of interfaces across all Network Devices, contains both interface configurations and statistics data
termsOfService: https://www.cisco.com/c/en/us/about/legal/cloud-and-software/end_user_license_agreement.html
contact:
name: Cisco TAC World Wide
url: https://www.cisco.com/c/en/us/support/web/tsd-cisco-worldwide-contacts.html
email: tac@cisco.com
license:
name: Apache-2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
version: 2.0.0
x-provenance:
method: harvested
authored_by: Cisco Catalyst Center
harvested_by: API Evangelist
harvested_on: '2026-08-19'
first_party: true
provider_published: true
source_host: developer.cisco.com
note: 27 Cisco-published OpenAPI 3.0 Assurance documents (185 operations). Ownership confirmed from the tac@cisco.com contact, the Cisco EULA terms-of-service URL and the Cisco Catalyst Center license block carried in each document.
x-evidence:
- type: source
url: https://developer.cisco.com/docs/catalyst-center/
- type: source
url: https://developer.cisco.com/dnacenter/
servers:
- url: https://developer.cisco.com/data/api/v1
tags:
- name: interfaceList
paths:
/dna/data/api/v1/interfaces:
get:
tags:
- interfaceList
summary: Gets interfaces along with statistics data from all network devices.
description: "Retrieves the list of the interfaces from all network devices based on the provided query parameters. The latest interfaces data in the specified start and end time range will be returned. When there is no start and end time specified returns the latest available data.\n\nThe elements are grouped and sorted by deviceUuid first, and are then sorted by the given sort field, or by the default value: name.\n\n\nThe supported sorting options are: \nname, adminStatus, description, duplexConfig, duplexOper, interfaceIfIndex,interfaceType, macAddress,mediaType, operStatus, portChannelId, portMode, portType,speed, vlanId\n\n\n\nThis API can paginate up to 500,000 records, please narrow matching results with additional filters beyond that value."
operationId: readInterfaces
parameters:
- name: startTime
in: query
description: 'Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.
'
schema:
type: integer
format: int64
example: 1705348800000
- name: endTime
in: query
description: 'End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.
'
required: false
schema:
type: integer
format: int64
example: 1705435200000
- name: limit
in: query
description: Maximum number of records to return
schema:
maximum: 1000
minimum: 1
type: integer
default: 500
- name: offset
in: query
description: Specifies the starting point within all records returned by the API. It's one based offset. The starting value is 1.
schema:
minimum: 1
type: integer
default: 1
- name: sortBy
in: query
description: A field within the response to sort by.
schema:
type: string
- name: order
in: query
description: The sort order of the field ascending or descending.
schema:
type: string
default: asc
enum:
- asc
- desc
- name: siteHierarchy
in: query
description: 'The full hierarchical breakdown of the site tree starting from Global site name and ending with the specific site name. The Root site is named "Global" (Ex. `Global/AreaName/BuildingName/FloorName`)
This field supports wildcard asterisk (`*`) character search support. E.g. `*/San*, */San, /San*`
Examples:
`?siteHierarchy=Global/AreaName/BuildingName/FloorName` (single siteHierarchy requested)
`?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Global/AreaName2/BuildingName2/FloorName2` (multiple siteHierarchies requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: siteHierarchyId
in: query
description: 'The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. `globalUuid/areaUuid/buildingUuid/floorUuid`)
This field supports wildcard asterisk (`*`) character search support. E.g. `*uuid*, *uuid, uuid*`
Examples:
`?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested)
`?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId=globalUuid/areaUuid2/buildingUuid2/floorUuid2` (multiple siteHierarchyIds requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: siteName
in: query
description: 'The name of the site. (Ex. `FloorName`)
This field supports wildcard asterisk (`*`) character search support. E.g. `*San*, *San, San*`
Examples:
`?siteName=building1` (single siteName requested)
`?siteName=building1&siteName=building2&siteName=building3` (multiple siteNames requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: siteId
in: query
description: 'The UUID of the site. (Ex. `flooruuid`)
Examples:
`?siteId=id1` (single id requested)
`?siteId=id1&siteId=id2&siteId=id3` (multiple ids requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: view
in: query
description: "Views which are supported by this API. Each view represents a specific data set.\n\n### Response data provided by each view: \n\n1. **configuration**\n[id,name,adminStatus,description,duplexConfig,duplexOper,interfaceIfIndex,interfaceType,ipv4Address,ipv6AddressList,isL3Interface,isWan,macAddress,mediaType,name,operStatus, portChannelId,portMode, portType,speed,timestamp,vlanId,networkDeviceId,networkDeviceIpAddress,networkDeviceMacAddress,siteName,siteHierarchy,siteHierarchyId] \n\n2. **statistics**\n[id,name,rxDiscards,rxError,rxRate,rxUtilization,txDiscards,txError,txRate,txUtilization,networkDeviceId,networkDeviceIpAddress,networkDeviceMacAddress,siteName,siteHierarchy,siteHierarchyId] \n3. **stackPort**\n[id,name,peerStackMember,peerStackPort,stackPortType,networkDeviceId,networkDeviceIpAddress,networkDeviceMacAddress,siteName,siteHierarchy,siteHierarchyId] \n4. **poE** \n[id, name,policingPoEEnabled,pdClassSignal,upoePlusEnabled,pdPowerRemainingInWatt,id,pdPowerAdminMaxInWatt,poeDataTimestamp,pdClassSpare,pdDeviceType,poeAdminStatus,name,fastPoEEnabled,pdMaxPowerDrawn,pdConnectedSwitch,pdConnectedDeviceList,pdLocation,moduleId,pdPowerConsumedInWatt,ieeeCompliant,poeOperPriority,pdPowerBudgetInWatt,pdDeviceModel,poeOperStatus,connectedSwitchType,pdDeviceName,perpetualPoEEnabled,fourPairEnabled,networkDeviceId,networkDeviceIpAddress,networkDeviceMacAddress,siteName,siteHierarchy,siteHierarchyId,] \n\n\nWhen this query parameter is not added by default all configuration attributes will be available in the response.\n\n**[configuration,statistics,stackPort]**\n"
required: false
style: form
explode: false
schema:
$ref: '#/components/schemas/InterfacesViews'
- name: attribute
in: query
description: 'The following list of attributes can be provided in the attribute field
[id,adminStatus, description,duplexConfig,duplexOper,interfaceIfIndex,interfaceType,ipv4Address,ipv6AddressList,isL3Interface,isWan,macAddress,mediaType,name,operStatus,peerStackMember,peerStackPort, portChannelId,portMode, portType,rxDiscards,rxError,rxRate,rxUtilization,speed,stackPortType,timestamp,txDiscards,txError,txRate,txUtilization,vlanId,networkDeviceId,networkDeviceIpAddress,networkDeviceMacAddress,siteName,siteHierarchy,siteHierarchyId]
If length of attribute list is too long, please use ''views'' param instead.
Examples:
attributes=name (single attribute requested)
attributes=name,description,duplexOper (multiple attributes with comma separator)
'
required: false
style: form
explode: false
schema:
type: array
items:
type: string
- name: networkDeviceId
in: query
description: 'The list of Network Device Uuids. (Ex. `6bef213c-19ca-4170-8375-b694e251101c`)
Examples:
`networkDeviceId=6bef213c-19ca-4170-8375-b694e251101c` (single networkDeviceId requested)
`networkDeviceId=6bef213c-19ca-4170-8375-b694e251101c&networkDeviceId=32219612-819e-4b5e-a96b-cf22aca13dd9&networkDeviceId=2541e9a7-b80d-4955-8aa2-79b233318ba0` (multiple networkDeviceIds with & separator)
'
style: form
explode: true
schema:
type: array
items:
type: string
- name: networkDeviceIpAddress
in: query
description: "The list of Network Device management IP Address. (Ex. `121.1.1.10`)\n\nThis field supports wildcard (`*`) character-based search. \nEx: `*1.1*` or `1.1*` or `*1.1`\n\nExamples:\n\n`networkDeviceIpAddress=121.1.1.10`\n\n`networkDeviceIpAddress=121.1.1.10&networkDeviceIpAddress=172.20.1.10&networkDeviceIpAddress=10.10.20.10` (multiple networkDevice IP Address with & separator)\n"
style: form
explode: true
schema:
type: array
items:
type: string
- name: networkDeviceMacAddress
in: query
description: "The list of Network Device MAC Address. (Ex. `64:f6:9d:07:9a:00`)\n\nThis field supports wildcard (`*`) character-based search. \nEx: `*AB:AB:AB*` or `AB:AB:AB*` or `*AB:AB:AB`\n\nExamples:\n\n`networkDeviceMacAddress=64:f6:9d:07:9a:00`\n\n`networkDeviceMacAddress=64:f6:9d:07:9a:00&networkDeviceMacAddress=70:56:9d:07:ac:77` (multiple networkDevice MAC addresses with & separator)\n"
style: form
explode: false
schema:
type: array
items:
type: string
format: mac
- name: interfaceId
in: query
description: 'The list of Interface Uuids. (Ex. `6bef213c-19ca-4170-8375-b694e251101c`)
Examples:
`interfaceId=6bef213c-19ca-4170-8375-b694e251101c` (single interface uuid )
`interfaceId=6bef213c-19ca-4170-8375-b694e251101c&32219612-819e-4b5e-a96b-cf22aca13dd9&2541e9a7-b80d-4955-8aa2-79b233318ba0` (multiple Interface uuid with & separator)
'
style: form
explode: true
schema:
type: array
items:
type: string
format: uuid
- name: interfaceName
in: query
description: "The list of Interface name (Ex. `GigabitEthernet1/0/1`)\nThis field supports wildcard (`*`) character-based search. \nEx: `*1/0/1*` or `1/0/1*` or `*1/0/1`\n\nExamples:\n\n`interfaceNames=GigabitEthernet1/0/1` (single interface name)\n\n`interfaceNames=GigabitEthernet1/0/1&GigabitEthernet2/0/1&GigabitEthernet3/0/1` (multiple interface names with & separator)\n"
style: form
explode: true
schema:
type: array
items:
type: string
responses:
'200':
description: Interfaces Response model on success
content:
'*/*':
schema:
$ref: '#/components/schemas/InterfacesResponse'
'400':
description: The client made a request that the server could not understand (for example, the request syntax is incorrect).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: The server could not fulfill the request due to internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
1XX:
description: Informational Responses - The server received the request and sent an informational response.
2XX:
description: Successful Responses - The server received the client request, understood it, and accepted it.
3XX:
description: Redirection Messages - The client must take additional action to complete the request.
4XX:
description: Client Error Responses - The client request caused the error.
5XX:
description: Server Error Responses - The server failed to fulfill the request.
default:
description: Unexpected Error
/dna/data/api/v1/interfaces/{id}:
get:
tags:
- interfaceList
summary: Get the interface data for the given interface id (instance Uuid) along with the statistics and poe data
description: Returns the interface data for the given interface instance Uuid along with the statistics data. The latest interface data in the specified start and end time range will be returned. When there is no start and end time specified returns the latest available data for the given interface Id.
operationId: readInterfaceById
parameters:
- name: id
in: path
description: The interface Uuid
required: true
style: simple
explode: false
schema:
type: string
- name: startTime
in: query
description: 'Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.
'
schema:
type: integer
format: int64
example: 1705348800000
- name: endTime
in: query
description: 'End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.
'
required: false
schema:
type: integer
format: int64
example: 1705435200000
- name: view
in: query
description: "Views which are supported by this API. Each view represents a specific data set.\n\n### Response data provided by each view: \n\n1. **configuration**\n[id,name,adminStatus,description,duplexConfig,duplexOper,interfaceIfIndex,interfaceType,ipv4Address,ipv6AddressList,isL3Interface,isWan,macAddress,mediaType,name,operStatus, portChannelId,portMode, portType,speed,timestamp,vlanId,networkDeviceId,networkDeviceIpAddress,networkDeviceMacAddress,siteName,siteHierarchy,siteHierarchyId] \n\n2. **statistics**\n[id,name,rxDiscards,rxError,rxRate,rxUtilization,txDiscards,txError,txRate,txUtilization,networkDeviceId,networkDeviceIpAddress,networkDeviceMacAddress,siteName,siteHierarchy,siteHierarchyId] \n3. **stackPort**\n[id,name,peerStackMember,peerStackPort,stackPortType,networkDeviceId,networkDeviceIpAddress,networkDeviceMacAddress,siteName,siteHierarchy,siteHierarchyId] \n4. **poE** \n[id, name,policingPoEEnabled,pdClassSignal,upoePlusEnabled,pdPowerRemainingInWatt,id,pdPowerAdminMaxInWatt,poeDataTimestamp,pdClassSpare,pdDeviceType,poeAdminStatus,name,fastPoEEnabled,pdMaxPowerDrawn,pdConnectedSwitch,pdConnectedDeviceList,pdLocation,moduleId,pdPowerConsumedInWatt,ieeeCompliant,poeOperPriority,pdPowerBudgetInWatt,pdDeviceModel,poeOperStatus,connectedSwitchType,pdDeviceName,perpetualPoEEnabled,fourPairEnabled,networkDeviceId,networkDeviceIpAddress,networkDeviceMacAddress,siteName,siteHierarchy,siteHierarchyId,] \n\n\nWhen this query parameter is not added by default all configuration attributes will be available in the response.\n\n**[configuration,statistics,stackPort]**\n"
required: false
style: form
explode: false
schema:
$ref: '#/components/schemas/InterfacesViews'
- name: attribute
in: query
description: 'The following list of attributes can be provided in the attribute field
[id,adminStatus, description,duplexConfig,duplexOper,interfaceIfIndex,interfaceType,ipv4Address,ipv6AddressList,isL3Interface,isWan,macAddress,mediaType,name,operStatus,peerStackMember,peerStackPort, portChannelId,portMode, portType,rxDiscards,rxError,rxRate,rxUtilization,speed,stackPortType,timestamp,txDiscards,txError,txRate,txUtilization,vlanId,networkDeviceId,networkDeviceIpAddress,networkDeviceMacAddress,siteName,siteHierarchy,siteHierarchyId]
If length of attribute list is too long, please use ''views'' param instead.
Examples:
attributes=name (single attribute requested)
attributes=name,description,duplexOper (multiple attributes with comma separator)
'
required: false
style: form
explode: false
schema:
type: array
items:
type: string
responses:
'200':
description: Interfaces Response model on success
content:
'*/*':
schema:
$ref: '#/components/schemas/InterfaceResponse'
'400':
description: The client made a request that the server could not understand (for example, the request syntax is incorrect).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: The server could not fulfill the request due to internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
1XX:
description: Informational Responses - The server received the request and sent an informational response.
2XX:
description: Successful Responses - The server received the client request, understood it, and accepted it.
3XX:
description: Redirection Messages - The client must take additional action to complete the request.
4XX:
description: Client Error Responses - The client request caused the error.
5XX:
description: Server Error Responses - The server failed to fulfill the request.
default:
description: Unexpected Error
/dna/data/api/v1/interfaces/count:
get:
tags:
- interfaceList
summary: 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.
description: Gets the total Network device interface counts. When counting over 40,000 matching interfaces, values may be approximate. Please apply additional filters to narrow results.
operationId: readInterfacesCount
parameters:
- name: startTime
in: query
description: 'Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.
'
schema:
type: integer
format: int64
example: 1705348800000
- name: endTime
in: query
description: 'End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.
'
required: false
schema:
type: integer
format: int64
example: 1705435200000
- name: siteHierarchy
in: query
description: 'The full hierarchical breakdown of the site tree starting from Global site name and ending with the specific site name. The Root site is named "Global" (Ex. `Global/AreaName/BuildingName/FloorName`)
This field supports wildcard asterisk (`*`) character search support. E.g. `*/San*, */San, /San*`
Examples:
`?siteHierarchy=Global/AreaName/BuildingName/FloorName` (single siteHierarchy requested)
`?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Global/AreaName2/BuildingName2/FloorName2` (multiple siteHierarchies requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: siteHierarchyId
in: query
description: 'The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. `globalUuid/areaUuid/buildingUuid/floorUuid`)
This field supports wildcard asterisk (`*`) character search support. E.g. `*uuid*, *uuid, uuid*`
Examples:
`?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested)
`?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId=globalUuid/areaUuid2/buildingUuid2/floorUuid2` (multiple siteHierarchyIds requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: siteName
in: query
description: 'The name of the site. (Ex. `FloorName`)
This field supports wildcard asterisk (`*`) character search support. E.g. `*San*, *San, San*`
Examples:
`?siteName=building1` (single siteName requested)
`?siteName=building1&siteName=building2&siteName=building3` (multiple siteNames requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: siteId
in: query
description: 'The UUID of the site. (Ex. `flooruuid`)
Examples:
`?siteId=id1` (single id requested)
`?siteId=id1&siteId=id2&siteId=id3` (multiple ids requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: networkDeviceId
in: query
description: 'The list of Network Device Uuids. (Ex. `6bef213c-19ca-4170-8375-b694e251101c`)
Examples:
`networkDeviceId=6bef213c-19ca-4170-8375-b694e251101c` (single networkDeviceId requested)
`networkDeviceId=6bef213c-19ca-4170-8375-b694e251101c&networkDeviceId=32219612-819e-4b5e-a96b-cf22aca13dd9&networkDeviceId=2541e9a7-b80d-4955-8aa2-79b233318ba0` (multiple networkDeviceIds with & separator)
'
style: form
explode: true
schema:
type: array
items:
type: string
- name: networkDeviceIpAddress
in: query
description: "The list of Network Device management IP Address. (Ex. `121.1.1.10`)\n\nThis field supports wildcard (`*`) character-based search. \nEx: `*1.1*` or `1.1*` or `*1.1`\n\nExamples:\n\n`networkDeviceIpAddress=121.1.1.10`\n\n`networkDeviceIpAddress=121.1.1.10&networkDeviceIpAddress=172.20.1.10&networkDeviceIpAddress=10.10.20.10` (multiple networkDevice IP Address with & separator)\n"
style: form
explode: true
schema:
type: array
items:
type: string
- name: networkDeviceMacAddress
in: query
description: "The list of Network Device MAC Address. (Ex. `64:f6:9d:07:9a:00`)\n\nThis field supports wildcard (`*`) character-based search. \nEx: `*AB:AB:AB*` or `AB:AB:AB*` or `*AB:AB:AB`\n\nExamples:\n\n`networkDeviceMacAddress=64:f6:9d:07:9a:00`\n\n`networkDeviceMacAddress=64:f6:9d:07:9a:00&networkDeviceMacAddress=70:56:9d:07:ac:77` (multiple networkDevice MAC addresses with & separator)\n"
style: form
explode: false
schema:
type: array
items:
type: string
format: mac
- name: interfaceId
in: query
description: 'The list of Interface Uuids. (Ex. `6bef213c-19ca-4170-8375-b694e251101c`)
Examples:
`interfaceId=6bef213c-19ca-4170-8375-b694e251101c` (single interface uuid )
`interfaceId=6bef213c-19ca-4170-8375-b694e251101c&32219612-819e-4b5e-a96b-cf22aca13dd9&2541e9a7-b80d-4955-8aa2-79b233318ba0` (multiple Interface uuid with & separator)
'
style: form
explode: true
schema:
type: array
items:
type: string
format: uuid
- name: interfaceName
in: query
description: "The list of Interface name (Ex. `GigabitEthernet1/0/1`)\nThis field supports wildcard (`*`) character-based search. \nEx: `*1/0/1*` or `1/0/1*` or `*1/0/1`\n\nExamples:\n\n`interfaceNames=GigabitEthernet1/0/1` (single interface name)\n\n`interfaceNames=GigabitEthernet1/0/1&GigabitEthernet2/0/1&GigabitEthernet3/0/1` (multiple interface names with & separator)\n"
style: form
explode: true
schema:
type: array
items:
type: string
responses:
'200':
description: Reponse object containing total count of the records after applying requested filters
content:
application/json:
schema:
$ref: '#/components/schemas/CountIntegerResponse'
'400':
description: The client made a request that the server could not understand (for example, the request syntax is incorrect).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: The server could not fulfill the request due to internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
1XX:
description: Informational Responses - The server received the request and sent an informational response.
2XX:
description: Successful Responses - The server received the client request, understood it, and accepted it.
3XX:
description: Redirection Messages - The client must take additional action to complete the request.
4XX:
description: Client Error Responses - The client request caused the error.
5XX:
description: Server Error Responses - The server failed to fulfill the request.
default:
description: Unexpected Error
/dna/data/api/v1/interfaces/query:
post:
tags:
- interfaceList
summary: Gets the list of interfaces across the Network Devices based on the provided complex filters and aggregation functions
description: "Gets the list of interfaces across the Network Devices based on the provided complex filters and aggregation functions\n\n\nThe elements are grouped and sorted by deviceUuid first, and are then sorted by the given sort field, or by the default value: name.\n\n\nThe supported sorting options are: \nname, adminStatus, description, duplexConfig, duplexOper, interfaceIfIndex,interfaceType, macAddress,mediaType, operStatus, portChannelId, portMode, portType,speed, vlanId, pdPowerAdminMaxInWatt,pdPowerBudgetInWatt,pdPowerConsumedInWatt,pdPowerRemainingInWatt,pdMaxPowerDrawn\n\n**How the filtering behavior works**\n\nThe filters field in each post body can be used in numerous ways:\n\nEach filter in the list of filters will applied ''together''\n\nIn the example below, this would request filtering to retrieve FullDuplex interfaces `and` portMode either trunk or access.\n```\n\"filters\": [\n {\n \"key\": \"duplexOper\",\n \"operator\": \"eq\",\n \"value\": \"FullDuplex\"\n },\n {\n \"key\": \"portMode\",\n \"operator\": \"in\",\n \"value\": [\n \"trunk\",\n \"access\"\n ]\n }\n]\n```\n\nEach filter object can contrastingly utilize its `logical operator` to provide nested filtering functionality.\n\nIn the example below you can see a logical \"OR\" filter being applied using the nested filtering functionality:\n\nThe primary filter object does not have its 'key', 'value', or 'operator' fields populated. Only the 'logicalOperator' field is populated, to indicate the filters within the nested filters list are to be logically conjoined.\n\n```\n\"filters\": [\n {\n \"logicalOperator\": \"or\",\n \"filters\": [\n {\n \"key\": \"siteName\",\n \"operator\": \"like\",\n \"value\": \"Paris\"\n },\n {\n \"key\": \"siteName\",\n \"operator\": \"eq\",\n \"value\": \"Eiffel Tower\"\n }\n ]\n }\n]\n```\nPlease refer to the 'API Support Documentation' section to understand which fields and filters are supported.\n\n**How Pagination Works**\n\n'limit' field, is the total number of records you want to retrieve.\n\n'offset' field, is the record you want to start on.\n\nIf you have a limit of 100, each page would be viewed as 100 elements. So starting with an offset of 1, means look at the first page of data. Starting with an offset of 2, means start on the second element (2nd-101st)\n\n'sortBy' field is a list, but only single field sorting is supported on this API.\n\nThe supported sorting options are: \n\nname, adminStatus, description, duplexConfig, duplexOper, interfaceIfIndex,interfaceType, macAddress,mediaType, operStatus, portChannelId, portMode, portType,speed, vlanId\n\nwith 'asc' (ascending), or 'desc' (descending) ordering.\n\nThis API can paginate up to 500,000 records, please narrow matching results with additional filters beyond that value.\n"
operationId: queryInterfacesWithFilter
requestBody:
description: Payload to query Network Device Interfaces
content:
application/json:
schema:
$ref: '#/components/schemas/InterfacesQueryRequest'
required: true
responses:
'200':
description: Interfaces Query Response model on success
content:
'*/*':
schema:
$ref: '#/components/schemas/InterfacesQueryResponse'
'400':
description: The client made a request that the server could not understand (for example, the request syntax is incorrect).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: The server could not fulfill the request due to internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
1XX:
description: Informational Responses - The server received the request and sent an informational response.
2XX:
description: Successful Responses - The server received the client request, understood it, and accepted it.
3XX:
description: Redirection Messages - The client must take additional action to complete the request.
4XX:
description: Client Error Responses - The client request caused the error.
5XX:
description: Server Error Responses - The server failed to fulfill the request.
default:
description: Unexpected Error
/dna/data/api/v1/interfaces/query/count:
post:
tags:
- interfaceList
summary: The Total interfaces count across the Network devices.
description: Gets the total number of interfaces across the Network devices based on the provided complex filters and aggregation functions. When counting over 40,000 matching interfaces, values may be approximate. Please apply additional filters to narrow results.
operationId: queryInterfaceCountWithFilter
requestBody:
description: Payload to query Network Device Interfaces
content:
applicatio
# --- truncated at 32 KB (73 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-catalyst-center/refs/heads/main/openapi/cisco-catalyst-center-interfacelist-api-openapi.yml