openapi: 3.2.0
info:
title: Cisco Catalyst Center Issues API
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'
description: 'Operations tagged issues across 2 of this provider''s published API definitions: cisco-catalyst-center-issues-lifecycle-openapi.yml,
cisco-catalyst-center-issues-list-openapi.yml. Each path carries the servers of the definition it was published in.'
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.
derived_view: Per-tag view of cisco-catalyst-center-issues-list-openapi.yml, the provider's source document. Operations
and schemas are the provider's, unmodified; only the partition is ours.
derived_from: cisco-catalyst-center-issues-list-openapi.yml
operation_coverage: 8/11
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
tags:
- name: issues
description: Operations related to Catalyst Center - Assurance Issues
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/intent/api/v1/assuranceIssues/resolve:
post:
tags:
- issues
summary: Resolve the given lists of issues
description: Resolves the given list of issues. The response contains the list of issues which were successfully resoved
as well as the issues which are failed to resovle. After this API returns success response, it may take few seconds
for the issue status to be updated if the system is heavily loaded. Please use `GET /dna/data/api/v1/assuranceIssues/{id}`
API to fetch the details of a particular issue and verify `updatedTime`.
operationId: resolveIssues
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:
description: Payload which contains list of issue ids to be resolved
content:
application/json:
schema:
$ref: '#/components/schemas/ResolveIssuesRequest'
required: true
responses:
'200':
description: Response model for resolve issues
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ResolveIssuesResponseModel'
'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
servers:
- url: https://developer.cisco.com
/dna/intent/api/v1/assuranceIssues/ignore:
post:
tags:
- issues
summary: Ignore the given list of issues
description: Ignores the given list of issues. The response contains the list of issues which were successfully ignored
as well as the issues which are failed to ignore. After this API returns success response, it may take few seconds
for the issue status to be updated if the system is heavily loaded. Please use `GET /dna/data/api/v1/assuranceIssues/{id}`
API to fetch the details of a particular issue and verify `updatedTime`.
operationId: ignoreIssues
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:
description: Payload which contains list of issue ids to be ignored
content:
application/json:
schema:
$ref: '#/components/schemas/IgnoreIssuesRequest'
required: true
responses:
'200':
description: Response model for ignore issues
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/IgnoreIssuesResponseModel'
'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
servers:
- url: https://developer.cisco.com
/dna/intent/api/v1/assuranceIssues/{id}/update:
post:
tags:
- issues
summary: Update the given issue by updating selected fields
description: Updates selected fields in the given issue. Currently the only field that can be updated is 'notes' field.
After this API returns success response, it may take few seconds for the issue status to be updated if the system
is heavily loaded. Please use `GET /dna/data/api/v1/assuranceIssues/{id}` API to fetch the details of a particular
issue and verify `updatedTime`.
operationId: updateIssue
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
- name: Accept-Language
in: header
description: This header parameter can be used to specify the language in which issue description and suggested actions
need to be returned. Available options are - 'en' (English), 'ja' (Japanese), 'ko' (Korean), 'zh' (Chinese). If
this parameter is not present the issue details are returned in English language.
required: false
style: simple
explode: false
schema:
type: string
enum:
- en
- ja
- ko
- zh
- name: id
in: path
description: The issue Uuid
required: true
style: simple
explode: false
schema:
type: string
requestBody:
description: Payload to to update the given issue
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateIssueRequest'
required: true
responses:
'200':
description: Response containing issue details of a given issue
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/IssueDetailResponseModel'
examples:
Response with all fields:
$ref: '#/components/examples/IssuesQueryResponseExample1'
Response with requested fields:
$ref: '#/components/examples/IssuesQueryResponseExample2'
'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'
'404':
description: The client made a request for a resource that does not exist.
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
servers:
- url: https://developer.cisco.com
/dna/data/api/v1/assuranceIssues/{id}:
get:
tags:
- issues
summary: Get all the details and suggested actions of an issue for the given issue id
description: Returns all the details and suggested actions of an issue for the given issue id.
operationId: readIssueById
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
- name: Accept-Language
in: header
description: This header parameter can be used to specify the language in which issue description and suggested actions
need to be returned. Available options are - 'en' (English), 'ja' (Japanese), 'ko' (Korean), 'zh' (Chinese). If
this parameter is not present the issue details are returned in English language.
required: false
schema:
type: string
enum:
- en
- ja
- ko
- zh
- name: id
in: path
description: The issue Uuid
required: true
schema:
type: string
- name: view
in: query
description: "The name of the View. Each view represents a specific data set. Please refer to the `IssuesView` Model\
\ for supported views. View is predefined set of attributes supported by the API. Only the attributes related to\
\ the given view will be part of the API response along with default attributes. If multiple views are provided,\
\ then response will contain attributes from all those views. If no views are specified, all attributes will be\
\ returned.\n\n| View Name | Included Attributes |\n| --- | --- |\n| `update` | updatedTime, updatedBy |\n| `site`\
\ | siteName, siteHierarchy, siteId, siteHierarchyId |\nExamples: `view=update` (single view requested) `view=update&view=site`\
\ (multiple views requested) \n"
required: false
style: form
explode: true
schema:
maxItems: 5
minItems: 1
type: array
items:
type: string
enum:
- update
- site
- name: attribute
in: query
description: 'List of attributes related to the issue. If these are provided, then only those attributes will be part
of response along with the default attributes. Please refer to the `IssuesResponseAttribute` Model for supported
attributes.
Examples: `attribute=deviceType` (single attribute requested) `attribute=deviceType&attribute=updatedBy` (multiple
attributes requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
enum:
- deviceType
- siteHierarchy
- siteHierarchyId
- siteName
- siteId
- notes
- updatedBy
- updatedTime
- suggestedActions
- additionalAttributes
responses:
'200':
$ref: '#/components/responses/IssueDetailResponseModel'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
1XX:
$ref: '#/components/responses/1XX'
2XX:
$ref: '#/components/responses/2XX'
3XX:
$ref: '#/components/responses/3XX'
4XX:
$ref: '#/components/responses/4XX'
5XX:
$ref: '#/components/responses/5XX'
default:
$ref: '#/components/responses/defaultError'
servers:
- url: https://developer.cisco.com
/dna/data/api/v1/assuranceIssues:
get:
tags:
- issues
summary: Get the details of issues for given set of filters
description: 'Returns all details of each issue along with suggested actions for given set of filters specified in query
parameters. If there is no start and/or end time, then end time will be defaulted to current time and start time will
be defaulted to 24-hours ago from end time. All string type query parameters support wildcard search (using *). For
example: siteHierarchy=Global/San Jose/* returns issues under all sites whole siteHierarchy starts with "Global/San
Jose/"'
operationId: readIssues
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
- name: Accept-Language
in: header
description: This header parameter can be used to specify the language in which issue description and suggested actions
need to be returned. Available options are - 'en' (English), 'ja' (Japanese), 'ko' (Korean), 'zh' (Chinese). If
this parameter is not present the issue details are returned in English language.
required: false
schema:
type: string
enum:
- en
- ja
- ko
- zh
- 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 issues to return
required: false
schema:
maximum: 25
minimum: 1
type: integer
default: 10
- 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
required: false
schema:
type: string
enum:
- name
- priority
- severity
- deviceType
- category
- entityType
- entityId
- firstOccurredTime
- mostRecentOccurredTime
- status
- updatedBy
- updatedTime
- name: order
in: query
description: The sort order of the field ascending or descending.
schema:
type: string
default: asc
enum:
- asc
- desc
- name: isGlobal
in: query
description: 'Global issues are those issues which impacts across many devices, sites. They are also displayed on
Issue Dashboard in Catalyst Center UI. Non-Global issues are displayed only on Client 360 or Device 360 pages. If
this flag is ''true'', only global issues are returned. If it is ''false'', only non-global issues are returned.
If this parameter is not sent, then all issues are returned.
'
required: false
schema:
type: boolean
example: true
- name: priority
in: query
description: 'Priority of the issue. Supports single priority and multiple priorities Examples: priority=P1 (single
priority requested) priority=P1&priority=P2&priority=P3 (multiple priorities requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
description: Priority of the issue
enum:
- P1
- P2
- P3
- P4
- name: severity
in: query
description: 'Severity of the issue. Supports single severity and multiple severities.
Examples:
severity=high (single severity requested)
severity=high&severity=medium (multiple severities requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
enum:
- high
- medium
- low
- name: status
in: query
description: 'Status of the issue. Supports single status and multiple statuses. Examples: status=active (single status
requested) status=active&status=resolved (multiple statuses requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
enum:
- active
- resolved
- ignored
- name: entityType
in: query
description: 'Entity type of the issue. Supports single entity type and multiple entity types. Examples: entityType=networkDevice
(single entity type requested) entityType=network device&entityType=client (multiple entity types requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
enum:
- network device
- client
- application
- sensor
- name: category
in: query
description: 'Categories of the issue. Supports single category and multiple categories. Examples: category=availability
(single status requested) category=availability&category=onboarding (multiple categories requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
description: Category of the issue
enum:
- onboarding
- connectivity
- connected
- device
- availability
- utilization
- application
- sensor test
- ap anomaly
- system
- beta analytics
- unknown
example: availability
- name: deviceType
in: query
description: 'Device Type of the device to which this issue belongs to. Supports single device type and multiple device
types.
Examples: deviceType=wireless controller (single device type requested) deviceType=wireless controller&deviceType=core
(multiple device types requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
enum:
- access point
- border router
- access
- core
- wireless controller
- sensor
- distribution
- wireless
- wired
- name: deviceFamily
in: query
description: 'Device Family of the device to which this issue belongs to. Supports single device family and multiple
device families.
Examples: deviceFamily=Unified AP (single device type requested) deviceFamily=Unified AP&deviceFamily=Routers (multiple
device types requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
enum:
- Unified AP
- Wireless Controller
- Routers
- Switches and Hubs
- Third Party Device
- name: name
in: query
description: 'The name of the issue
Examples:
name=ap_down (single issue name requested)
name=ap_down&name=wlc_monitor (multiple issue names requested)
Issue names can be retrieved using the API - /intent/api/v1/systemIssueDefinitions
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: issueId
in: query
description: 'UUID of the issue Examples: issueId=e52aecfe-b142-4287-a587-11a16ba6dd26 (single issue id requested)
issueId=e52aecfe-b142-4287-a587-11a16ba6dd26&issueId=864d0421-02c0-43a6-9c52-81cad45f66d8 (multiple issue ids requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: entityId
in: query
description: "Id of the entity for which this issue belongs to. For example, it\n could be mac address of AP or\
\ UUID of Sensor\n example: 68:ca:e4:79:3f:20 4de02167-901b-43cf-8822-cffd3caa286f\nExamples: entityId=68:ca:e4:79:3f:20\
\ (single entity id requested) entityId=68:ca:e4:79:3f:20&entityId=864d0421-02c0-43a6-9c52-81cad45f66d8 (multiple\
\ entity ids requested)\n"
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: updatedBy
in: query
description: 'The user who last updated this issue. Examples: updatedBy=admin (single updatedBy requested) updatedBy=admin&updatedBy=john
(multiple updatedBy requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- 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: 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: fabricSiteId
in: query
description: 'The UUID of the fabric site. (Ex. "flooruuid")
Examples: fabricSiteId=e52aecfe-b142-4287-a587-11a16ba6dd26 (single id requested) fabricSiteId=e52aecfe-b142-4287-a587-11a16ba6dd26,864d0421-02c0-43a6-9c52-81cad45f66d8
(multiple ids requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: fabricVnName
in: query
description: 'The name of the fabric Virtual Network (VN). When this filter is applied, issues related to the given
VN(s) are returned. There are two categories of issues pertaining to Fabric VNs: Type 1: Global Issue - This is
an aggregate issue reported at the device level, summarizing issues across all VNs. These issues are returned by
API when `fabricVnName` filter is not applied. Type 2: VN-level Issue - These issues are created at VN level, for
each VN. In scenarios where a device is associated with multiple VNs, there will be a separate VN-level issue reported
for each VN. These issues are returned by API only when `fabricVnName` filter is applied or when fabricVnDriven
filter is set to `true`.
Examples: fabricVnName=name1 (single fabric virtual network name requested) fabricVnName=name1&fabricVnName=name2&fabricVnName=name3
(multiple fabric virtual network names requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: fabricTransitSiteId
in: query
description: 'The UUID of the fabric transit site. (Ex. "flooruuid")
Examples: fabricTransitSiteId=e52aecfe-b142-4287-a587-11a16ba6dd26 (single id requested) fabricTransitSiteId=e52aecfe-b142-4287-a587-11a16ba6dd26&fabricTransitSiteId=864d0421-02c0-43a6-9c52-81cad45f66d8
(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: macAddress
in: query
description: "The macAddress of the network device or client\nThis field supports wildcard (`*`) character-based search.\
\ \nEx: `*AB:AB:AB*` or `AB:AB:AB*` or `*AB:AB:AB`\nExamples:\n\n`macAddress=AB:AB:AB:CD:CD:CD` (single macAddress\
\ requested)\n\n`macAddress=AB:AB:AB:CD:CD:DC&macAddress=AB:AB:AB:CD:CD:FE` (multiple macAddress requested)\n"
style: form
explode: true
schema:
type: array
items:
type: string
- name: view
in: query
description: "The name of the View. Each view represents a specific data set. Please refer to the `IssuesView` Model\
\ for supported views. View is predefined set of attributes supported by the API. Only the attributes related to\
\ the given view will be part of the API response along with default attributes. If multiple views are provided,\
\ then response will contain attributes from all those views. If no views are specified, all attributes will be\
\ returned.\n\n| View Name | Included Attributes |\n| --- | --- |\n| `update` | updatedTime, updatedBy |\n| `site`\
\ | siteName, siteHierarchy, siteId, siteHierarchyId |\nExamples: `view=update` (single view requested) `view=update&view=site`\
\ (multiple views requested) \n"
required: false
style: form
explode: true
# --- truncated at 32 KB (149 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-catalyst-center/refs/heads/main/openapi/cisco-catalyst-center-issues-api-openapi.yml