openapi: 3.2.0
info:
title: OpenAPI specification Network Applications API
description: 'OpenAPI specification for Catalyst Center - Appx Network Applications
'
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: Cisco Catalyst Center License
url: https://www.cisco.com/c/en/us/products/collateral/software/dna-software-ebook-cte.html
version: 1.0.2
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/dna/data/api/v1
tags:
- name: networkApplications
description: Operations related to Catalyst Center - Appx Network Applications
externalDocs:
description: Catalyst Center Assurance user guide
url: https://www.cisco.com/c/en/us/support/cloud-systems-management/dna-center/products-user-guide-list.html
paths:
/dna/data/api/v1/networkApplications:
get:
tags:
- networkApplications
summary: Retrieves the list of network applications along with experience and health metrics
description: Retrieves the list of network applications along with experience and health metrics. If startTime and endTime are not provided, the API defaults to the last 24 hours. `siteId` is mandatory. `siteId` must be a site UUID of a building.
operationId: readNetworkApplications
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: 500
minimum: 1
type: integer
default: 100
- 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: siteId
in: query
description: 'The site UUID without the top level hierarchy.`siteId` is mandatory. `siteId` must be a site UUID of a building. (Ex."buildingUuid") Examples:
`siteId=buildingUuid` (single siteId requested)
`siteId=buildingUuid1&siteId=buildingUuid2` (multiple siteId requested)'
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: exporterNetworkDeviceId
in: query
description: 'Unique ID of the netflow exporter device.
Examples:
`exporterNetworkDeviceId=5b234dbc-583e-491b-bf1a-318bba6c017f` (single exporterNetworkDeviceId requested)
`exporterNetworkDeviceId=5b234dbc-583e-491b-bf1a-318bba6c017f&exporterNetworkDeviceId=8b234dbc-583e-491b-bf1a-318bba6c017f` (multiple exporterNetworkDeviceId requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: ssid
in: query
description: 'In the context of a network application, SSID refers to the name of the wireless network to which the client connects.
Examples:
`ssid=Alpha` (single ssid requested)
`ssid=Alpha&ssid=Guest` (multiple ssid requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: applicationName
in: query
description: 'Name of the application for which the experience data is intended.
Examples:
`applicationName=webex` (single applicationName requested)
`applicationName=webex&applicationName=teams` (multiple applicationName requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: businessRelevance
in: query
description: 'The application can be chosen to be categorized as business-relevant, irrelevant, or default (neutral). By doing so, the assurance application prioritizes the monitoring and analysis of business-relevant data, ensuring critical insights are captured. Applications marked as irrelevant or default are selectively excluded from certain data sets, streamlining focus on what''s most important for business outcomes.
'
required: false
style: form
explode: true
schema:
type: string
enum:
- BUSINESS_RELEVANT
- BUSINESS_IRRELEVANT
- DEFAULT
example: BUSINESS_RELEVANT
- name: healthScore
in: query
description: 'Application health score.
Examples:
`healthScore=7` (single healthScore requested)
`healthScore=7&healthScore=3` (multiple healthScore requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: integer
- name: attribute
in: query
description: 'List of attributes related to resource that can be requested to only be part of the response along with the required attributes. Supported attributes are applicationName, siteId, exporterIpAddress, exporterNetworkDeviceId, healthScore, businessRelevance, usage, throughput, packetLossPercent, networkLatency, applicationServerLatency, clientNetworkLatency, serverNetworkLatency, trafficClass, jitter, ssid Examples:
`attribute=healthScore` (single attribute requested)
`attribute=healthScore&attribute=ssid&attribute=jitter` (multiple attribute requested)'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: X-CALLER-ID
in: header
description: 'Caller ID is used to trace the origin of API calls and their associated queries executed on the database. It''s an optional header parameter that can be added to an API request.
'
required: false
schema:
type: string
default: unknown
example: ui:client360
responses:
'200':
description: Collection of application experience records
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/NetworkApplicationsResponseModel'
examples:
networkApplicationsResponse:
$ref: '#/components/examples/networkApplicationsResponse'
'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/AppxErrorResponse'
'500':
description: The server could not fulfill the request due to internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/AppxErrorResponse'
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/networkApplications/count:
get:
tags:
- networkApplications
summary: Retrieves the total count of network applications by applying basic filtering
description: Retrieves the number of network applications by applying basic filtering. If startTime and endTime are not provided, the API defaults to the last 24 hours. `siteId` is mandatory. `siteId` must be a site UUID of a building.
operationId: readNetworkApplicationsCount
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: siteId
in: query
description: 'The site UUID without the top level hierarchy.`siteId` is mandatory. `siteId` must be a site UUID of a building. (Ex."buildingUuid") Examples:
`siteId=buildingUuid` (single siteId requested)
`siteId=buildingUuid1&siteId=buildingUuid2` (multiple siteId requested)'
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: exporterNetworkDeviceId
in: query
description: 'Unique ID of the netflow exporter device.
Examples:
`exporterNetworkDeviceId=5b234dbc-583e-491b-bf1a-318bba6c017f` (single exporterNetworkDeviceId requested)
`exporterNetworkDeviceId=5b234dbc-583e-491b-bf1a-318bba6c017f&exporterNetworkDeviceId=8b234dbc-583e-491b-bf1a-318bba6c017f` (multiple exporterNetworkDeviceId requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: ssid
in: query
description: 'In the context of a network application, SSID refers to the name of the wireless network to which the client connects.
Examples:
`ssid=Alpha` (single ssid requested)
`ssid=Alpha&ssid=Guest` (multiple ssid requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: applicationName
in: query
description: 'Name of the application for which the experience data is intended.
Examples:
`applicationName=webex` (single applicationName requested)
`applicationName=webex&applicationName=teams` (multiple applicationName requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: businessRelevance
in: query
description: 'The application can be chosen to be categorized as business-relevant, irrelevant, or default (neutral). By doing so, the assurance application prioritizes the monitoring and analysis of business-relevant data, ensuring critical insights are captured. Applications marked as irrelevant or default are selectively excluded from certain data sets, streamlining focus on what''s most important for business outcomes.
'
required: false
style: form
explode: true
schema:
type: string
enum:
- BUSINESS_RELEVANT
- BUSINESS_IRRELEVANT
- DEFAULT
example: BUSINESS_RELEVANT
- name: healthScore
in: query
description: 'Application health score.
Examples:
`healthScore=7` (single healthScore requested)
`healthScore=7&healthScore=3` (multiple healthScore requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: integer
- name: X-CALLER-ID
in: header
description: 'Caller ID is used to trace the origin of API calls and their associated queries executed on the database. It''s an optional header parameter that can be added to an API request.
'
required: false
schema:
type: string
default: unknown
example: ui:client360
responses:
'200':
description: Reponse object containing total count of the records after applying requested filters
content:
application/json:
schema:
$ref: '#/components/schemas/NetworkApplicationCountIntegerResponse'
'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/AppxErrorResponse'
'500':
description: The server could not fulfill the request due to internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/AppxErrorResponse'
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/networkApplications/trendAnalytics:
post:
tags:
- networkApplications
summary: Retrieves the Trend analytics data related to network applications.
description: 'Retrieves the trend analytics of applications experience data for the specified time range. The data will be grouped based on the given trend time interval. This API facilitates obtaining consolidated insights into the performance and status of the network applications over the specified start and end time. If startTime and endTime are not provided, the API defaults to the last 24 hours. `siteId` and `trendInterval` are mandatory. `siteId` must be a site UUID of a building.
**The input payload contains the following fields,**
|Field Name | Description |
| --- | --- |
| `startTime` | The start time indicates when the API begins retrieving data related to the resource. It must be specified in the UNIX epoch time format, measured in milliseconds. This value is inclusive, and if left unspecified, the default is 1 day before the endTime.|
| `endTime` | The end time indicates the upper limit until which the API retrieves data related to the resource. It must be defined in the UNIX epoch time format, measured in milliseconds. This value is inclusive, and if left unspecified, the default is the latest available data. |
| `siteIds` | The list of site UUIDs. This is a mandatory field. Please note that only Building UUIDs are allowed for this field.|
| `trendInterval` | The time window for aggregating metrics. This is a mandatory request field. Possible values include *5 minutes, 10 minutes, 1 hour or 3 hour. Upto 3 hours time window allowed intervals 5MIN and 10MIN and more than 3 hours time window allowed intervals 1HR and 3HR. |
| `groupBy` | Specifies the attributes for grouping the data. Refer to `NetworkApplicationGroupByField` model for the supported grouping attributes|
| `attributes` | A list of attributes associated with the resource, which can be requested to be included in the response alongside the required attributes. Refer to `NetworkApplicationTrendAttribute` model for the supported attributes |
| `aggregateAttributes` | This specifies the attribute name and the function to be applied during data querying. The aggregate function is then applied to data within the specified start and end times. Refer to `NetworkApplicationAggregateField` model for the supported aggregate attributes |
|`filters`| This is used to specify one or more conditions for filtering the queried data. Refer to `NetworkApplicationFilterField` model for the supported filters |
|`page`| It includes the **limit, cursor, and timeSortOrder** fields. *limit* denotes the number of records to process per page, *cursor* signifies the initial data position, and *timeSortOrder* is used sort the response based on the timestamp either in ascending or descending order. Default page limit is 100 and order is asc|'
operationId: queryNetworkApplicationsTrendAnalytics
parameters:
- name: X-CALLER-ID
in: header
description: 'Caller ID is used to trace the origin of API calls and their associated queries executed on the database. It''s an optional header parameter that can be added to an API request.
'
required: false
schema:
type: string
default: unknown
example: ui:client360
requestBody:
$ref: '#/components/requestBodies/NetworkApplicationTrendQueryRequest'
responses:
'200':
description: Collection of trend responses with Network Applications Response model on success with aggregate attributes and groupBy
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/NetworkApplicationTrendResponse'
examples:
networkApplicationTrendResponseWithoutGroupBy:
$ref: '#/components/examples/networkApplicationTrendResponseWithoutGroupBy'
networkApplicationTrendResponseWithGroupBy:
$ref: '#/components/examples/networkApplicationTrendResponseWithGroupBy'
'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/AppxErrorResponse'
'500':
description: The server could not fulfill the request due to internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/AppxErrorResponse'
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/networkApplications/{id}/trendAnalytics:
post:
tags:
- networkApplications
summary: Retrieves the Trend analytics related to specific network application.
description: 'Retrieves the trend analytics of applications experience data to the specific network application for the specified time range. The data will be grouped based on the given trend time interval. This API facilitates obtaining consolidated insights into the performance and status of the network applications over the specified start and end time. If startTime and endTime are not provided, the API defaults to the last 24 hours.`siteId` and `trendInterval` are mandatory. `siteId` must be a site UUID of a building.
**The input payload contains the following fields,**
|Field Name | Description |
| --- | --- |
| `startTime` | The start time indicates when the API begins retrieving data related to the resource. It must be specified in the UNIX epoch time format, measured in milliseconds. This value is inclusive, and if left unspecified, the default is 1 day before the endTime.|
| `endTime` | The end time indicates the upper limit until which the API retrieves data related to the resource. It must be defined in the UNIX epoch time format, measured in milliseconds. This value is inclusive, and if left unspecified, the default is the latest available data. |
| `siteIds` | The list of site UUIDs. This is a mandatory field. Please note that only Building UUIDs are allowed for this field. |
| `trendInterval` | The time window for aggregating metrics. This is a mandatory request field. Possible values include *5 minutes, 10 minutes, 1 hour or 3 hour. Upto 1 day time window allowed intervals 5MIN and 10MIN and more than 1 day time window allowed intervals 1HR and 3HR. |
| `groupBy` | Specifies the attributes for grouping the data. Refer to `NetworkApplicationGroupByField` model for the supported grouping attributes|
| `attributes` | A list of attributes associated with the resource, which can be requested to be included in the response alongside the required attributes. Refer to `NetworkApplicationTrendAttribute` model for the supported attributes |
| `aggregateAttributes` | This specifies the attribute name and the function to be applied during data querying. The aggregate function is then applied to data within the specified start and end times. Refer to `NetworkApplicationAggregateField` model for the supported aggregate attributes |
|`filters`| This is used to specify one or more conditions for filtering the queried data. Refer to `NetworkApplicationFilterField` model for the supported filters. The filter applicationName is not supported. |
|`page`| It includes the **limit, cursor, and timeSortOrder** fields. *limit* denotes the number of records to process per page, *cursor* signifies the initial data position, and *timeSortOrder* is used sort the response based on the timestamp either in ascending or descending order. Default page limit is 100 and order is asc|'
operationId: queryNetworkApplicationTrendAnalyticsById
parameters:
- name: id
in: path
description: 'id is the network application name.
'
required: true
style: simple
explode: false
schema:
type: string
- name: X-CALLER-ID
in: header
description: 'Caller ID is used to trace the origin of API calls and their associated queries executed on the database. It''s an optional header parameter that can be added to an API request.
'
required: false
schema:
type: string
default: unknown
example: ui:client360
requestBody:
$ref: '#/components/requestBodies/NetworkApplicationTrendQueryRequest'
responses:
'200':
description: Collection of trend responses with Network Applications Response model on success with aggregate attributes and groupBy
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/NetworkApplicationTrendResponse'
examples:
networkApplicationTrendResponseWithoutGroupBy:
$ref: '#/components/examples/networkApplicationTrendResponseWithoutGroupBy'
networkApplicationTrendResponseWithGroupBy:
$ref: '#/components/examples/networkApplicationTrendResponseWithGroupBy'
'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/AppxErrorResponse'
'500':
description: The server could not fulfill the request due to internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/AppxErrorResponse'
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/networkApplications/summaryAnalytics:
post:
tags:
- networkApplications
summary: Retrieves summary analytics data related to network applications along with health metrics.
description: 'Retrieves summary analytics data related to network applications while applying complex filtering, aggregate functions, and grouping. This API facilitates obtaining consolidated insights into the performance and status of the network applications. If startTime and endTime are not provided, the API defaults to the last 24 hours.
**The input payload contains the following fields:**
|Field Name | Description |
| --- | --- |
| `startTime` | The start time indicates when the API begins retrieving data related to the resource. It must be specified in the UNIX epoch time format, measured in milliseconds. This value is inclusive, and if left unspecified, the default is 1 day before the endTime. |
| `endTime` | The end time indicates the upper limit until which the API retrieves data related to the resource. It must be defined in the UNIX epoch time format, measured in milliseconds. This value is inclusive, and if left unspecified, the default is the latest available data. |
| `siteIds` | The list of site UUIDs. This is a mandatory field. Please note that only Building UUIDs are allowed for this field. |
| `groupBy` | Specifies the attributes for grouping the data. Refer to `NetworkApplicationGroupByField` model for the supported grouping attributes. |
| `attributes` | A list of attributes associated with the resource, which can be requested to be included in the response alongside the required attributes. Refer to `NetworkApplicationSummaryAttributes` model for the supported attributes |
| `aggregateAttributes` | This specifies the attribute name and the function to be applied during data querying. The aggregate function is then applied to data within the specified start and end times. Refer to `NetworkApplicationAggregateField` model for the supported aggregate attributes |
|`filters`| This is used to specify one or more conditions for filtering the queried data. Refer to `NetworkApplicationFilterField` model for the supported filters |
|`page`| It includes the **limit, cursor, and sortBy** fields. *limit* denotes the number of records to retrieve per page, *cursor* signifies the initial data position, and *sortBy* is used to sort the response based on the sortBy fields. It contains the attribute name, order, and optional function for sorting by the aggregated field. Refer to `NetworkApplicationSortByObj` model for the supported sortBy names. Default page limit is 100 and sortBy is applicationName |'
operationId: queryNetworkApplicationsSummaryAnalytics
parameters:
- name: X-CALLER-ID
in: header
description: 'Caller ID is used to trace the origin of API calls and their associated queries executed on the database. It''s an optional header parameter that can be added to an API request.
'
required: false
schema:
type: string
default: unknown
example: ui:client360
requestBody:
$ref: '#/components/requestBodies/NetworkApplicationSummaryRequest'
responses:
'200':
description: Collection of summary responses with aggregate attributes and groupBy
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/NetworkApplicationSummaryResponse'
examples:
networkApplicationSummaryResponseWithoutGroupBy:
$ref: '#/components/examples/networkApplicationSummaryResponseWithoutGroupBy'
networkApplicationSummaryResponseWithGroupBy:
$ref: '#/components/examples/networkApplicationSummaryResponseWithGroupBy'
'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/AppxErrorResponse'
'500':
description: The server could not fulfill the request due to internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/AppxErrorResponse'
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/networkApplications/{id}/clients:
get:
tags:
- networkApplications
summary: Retrieves the list of clients metrics for the given application.
description: Retrieves the list of clients metrics for the given application. If startTime and endTime are not provided, the API defaults to the last 24 hours. `siteId` is mandatory. `siteId` must be a site UUID of a building. For the given time range and filters, the API will get the list of unique clients which matched the filter criteria.
operationId: readNetworkApplicationClientsById
parameters:
- name: id
in: path
description: 'id is the network application name.
'
required: true
style: simple
explode: false
schema:
# --- truncated at 32 KB (84 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-catalyst-center/refs/heads/main/openapi/cisco-catalyst-center-networkapplications-api-openapi.yml