openapi: 3.2.0 info: title: Open API spec to define issue trigger violation and health score definitions. System Issue And Health Score Definitions API description: APIs to customize issue trigger priority, enable/disable issues, health thresholds and include status of KPI into overall health computations. 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.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 tags: - name: systemIssueAndHealthScoreDefinitions description: Operations related to system issue trigger definitions and health score definitions. 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/systemIssueDefinitions: get: tags: - systemIssueAndHealthScoreDefinitions summary: Returns all issue trigger definitions for given filters. description: 'Get all system issue defintions. The supported filters are id, name, profileId and definition enable status. An issue trigger definition can be different across the profile and device type. So, `profileId` and `deviceType` in the query param is important and default is global profile and all device type. ' operationId: readSystemsIssueDefinitions parameters: - name: deviceType in: query description: These are the device families/types supported for system issue definitions. If no input is made on device type, all device types are considered. required: false style: form explode: true schema: type: string enum: - Router - Switch and Hub - Wireless Controller - Unified AP - Wireless Client - Wired Client - Application - Sensor - Third Party Device - name: profileId in: query description: The profile identier to fetch the profile associated issue defintions. The default is `global`. Please refer Network design profiles documentation for more details. required: false style: form explode: true schema: type: string default: global - name: id in: query description: 'The definition identifier. Examples: id=015d9cba-4f53-4087-8317-7e49e5ffef46 (single entity id request) id=015d9cba-4f53-4087-8317-7e49e5ffef46&id=015d9cba-4f53-4087-8317-7e49e5ffef47 (multiple ids in the query param) ' required: false style: form explode: true schema: type: string format: uuid - name: name in: query description: 'The list of system defined issue names. (Ex."BGP_Down") Examples: name=BGP_Down (single entity uuid requested) name=BGP_Down&name=BGP_Flap (multiple issue names separated by & operator) ' required: false style: form explode: true schema: type: string - name: priority in: query description: 'Issue priority, possible values are P1, P2, P3, P4. `P1`: A critical issue that needs immediate attention and can have a wide impact on network operations. `P2`: A major issue that can potentially impact multiple devices or clients. `P3`: A minor issue that has a localized or minimal impact. `P4`: A warning issue that may not be an immediate problem but addressing it can optimize the network performance. ' required: false style: form explode: true schema: type: string - name: issueEnabled in: query description: The enablement status of the issue definition, either true or false. required: false style: form explode: true schema: type: string default: 'true' - name: attribute in: query description: 'These are the attributes supported in system issue definitions response. By default, all properties are sent in response. ' required: false style: form explode: true schema: type: array items: type: string enum: - categoryName - definitionStatus - defaultPriority - description - deviceFamily - deviceType - id - issueEnabled - name - priority - profileId - synchronizeToHealthThreshold - thresholdValue - 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: limit in: query description: Maximum number of records to return schema: minimum: 1 type: integer default: 500 - 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: 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: Response object for the list of issue trigger definitions. content: application/json: schema: $ref: '#/components/schemas/IssueTriggerDefinitionListResponse' example: response: - id: 015d9cba-4f53-4087-8317-7e49e5ffef46 displayName: Network Device Interface Connectivity - ISIS Adjacency Failure name: isis_adjacency_failure deviceFamily: Router description: ISIS Adjacency failed on Device. priority: P2 defaultPriority: P3 deviceType: Router issueEnabled: true profileId: global definitionStatus: CUSTOM categoryName: Connectivity synchronizeToHealthThreshold: false thresholdValue: 90 - id: 015d9cba-4f53-4087-8317-7e49e5ffef47 displayName: Network Device Interface Connectivity - ISIS Adjacency Failure name: isis_adjacency_failure deviceFamily: Switches And Hubs description: ISIS Adjacency failed on Device. priority: P2 defaultPriority: P2 deviceType: Switches And Hubs issueEnabled: true profileId: global definitionStatus: DEFAULT categoryName: Connectivity synchronizeToHealthThreshold: false thresholdValue: 90 version: '1.0' page: offset: 5 limit: 10 sortBy: name order: asc '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' '401': description: The client's authentication credentials included with the request are missing or invalid. '403': description: The server recognizes the authentication credentials, but the client is not authorized to perform this request. '406': description: The client requested a response in a content format that this server does not support. '500': description: The server could not fulfill the request due to internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '502': description: There is a bad gateway connection from the client to the server. '503': description: The server is (temporarily) unavailable. '504': description: The server did not respond inside time restrictions and time-out. 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. /dna/intent/api/v1/systemIssueDefinitions/{id}: get: tags: - systemIssueAndHealthScoreDefinitions summary: Get issue trigger definition for given id. description: Get system issue defintion for the given id. Definition includes all properties from IssueTriggerDefinition schema by default. operationId: readSystemIssueDefinitionById parameters: - name: id in: path description: Issue trigger definition id. required: true style: simple explode: false schema: type: string format: uuid - 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: Response object for a specific issue trigger definition. content: application/json: schema: $ref: '#/components/schemas/IssueTriggerDefinitionResponse' example: response: id: 015d9cba-4f53-4087-8317-7e49e5ffef46 name: isis_adjacency_failure displayName: Network Device Interface Connectivity - ISIS Adjacency Failure description: ISIS Adjacency failed on Device. priority: P1 defaultPriority: P1 deviceType: Router issueEnabled: true profileId: c88a2547-551b-4d30-bfd2-bec068336fdd definitionStatus: DEFAULT categoryName: Connectivity synchronizeToHealthThreshold: true thresholdValue: 90 lastModified: '' version: '1.0' '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' '401': description: The client's authentication credentials included with the request are missing or invalid. '403': description: The server recognizes the authentication credentials, but the client is not authorized to perform this request. '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' '501': description: The server has not implemented the functionality required to fulfill the request. '502': description: There is a bad gateway connection from the client to the server. '503': description: The server is (temporarily) unavailable. 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. put: tags: - systemIssueAndHealthScoreDefinitions summary: Issue trigger definition update. description: 'Update issue trigger threshold, priority for the given id. Also enable or disable issue trigger for the given id. ' operationId: putSystemIssueDefinitionById parameters: - name: id in: path description: Issue trigger definition id. required: true style: simple explode: false schema: type: string format: uuid - 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: Update issue trigger definition. content: application/json: schema: $ref: '#/components/schemas/IssueTriggerDefinition' example: priority: P1 deviceType: Router issueEnabled: true synchronizeToHealthThreshold: true thresholdValue: 90 lastModified: '' required: true responses: '200': description: Response object for a specific issue trigger definition. content: application/json: schema: $ref: '#/components/schemas/IssueTriggerDefinitionResponse' example: response: id: 015d9cba-4f53-4087-8317-7e49e5ffef46 name: isis_adjacency_failure displayName: Network Device Interface Connectivity - ISIS Adjacency Failure description: ISIS Adjacency failed on Device. priority: P1 defaultPriority: P1 deviceType: Router issueEnabled: true profileId: c88a2547-551b-4d30-bfd2-bec068336fdd definitionStatus: DEFAULT categoryName: Connectivity synchronizeToHealthThreshold: true thresholdValue: 90 lastModified: '' version: '1.0' '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' '401': description: The client's authentication credentials included with the request are missing or invalid. '403': description: The server recognizes the authentication credentials, but the client is not authorized to perform this request. '404': description: The client made a request for a resource that does not exist. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '405': description: The client made a request using an http method which is not supported for this resource. '406': description: The client requested a response in a content format that this server does not support. '415': description: The client sent a request body in a format that the server does not support (for example, XML to a server that only accepts JSON). '500': description: The server could not fulfill the request due to internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '501': description: The server has not implemented the functionality required to fulfill the request. '502': description: There is a bad gateway connection from the client to the server. '503': description: The server is (temporarily) unavailable. '504': description: The server did not respond inside time restrictions and time-out. 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. /dna/intent/api/v1/systemIssueDefinitions/count: get: tags: - systemIssueAndHealthScoreDefinitions summary: Get the count of system defined issue definitions based on provided filters. description: 'Get the count of system defined issue definitions based on provided filters. Supported filters are id, name, profileId and definition enable status. ' operationId: readSystemIssueDefinitionsCount parameters: - name: deviceType in: query description: These are the device families/types supported for system issue definitions. If no input is made on device type, all device types are considered. required: false style: form explode: true schema: type: string enum: - Router - Switch and Hub - Wireless Controller - Unified AP - Wireless Client - Wired Client - Application - Sensor - Third Party Device - name: profileId in: query description: The profile identier to fetch the profile associated issue defintions. The default is `global`. Please refer Network design profiles documentation for more details. required: false style: form explode: true schema: type: string default: global - name: id in: query description: 'The definition identifier. Examples: id=015d9cba-4f53-4087-8317-7e49e5ffef46 (single entity id request) id=015d9cba-4f53-4087-8317-7e49e5ffef46&id=015d9cba-4f53-4087-8317-7e49e5ffef47 (multiple ids in the query param) ' required: false style: form explode: true schema: type: string format: uuid - name: name in: query description: 'The list of system defined issue names. (Ex."BGP_Down") Examples: name=BGP_Down (single entity uuid requested) name=BGP_Down&name=BGP_Flap (multiple issue names separated by & operator) ' required: false style: form explode: true schema: type: string - name: priority in: query description: 'Issue priority, possible values are P1, P2, P3, P4. `P1`: A critical issue that needs immediate attention and can have a wide impact on network operations. `P2`: A major issue that can potentially impact multiple devices or clients. `P3`: A minor issue that has a localized or minimal impact. `P4`: A warning issue that may not be an immediate problem but addressing it can optimize the network performance. ' required: false style: form explode: true schema: type: string - name: issueEnabled in: query description: The enablement status of the issue definition, either true or false. required: false style: form explode: true schema: type: string default: 'true' - 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/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' '401': description: The client's authentication credentials included with the request are missing or invalid. '403': description: The server recognizes the authentication credentials, but the client is not authorized to perform this request. '406': description: The client requested a response in a content format that this server does not support. '500': description: The server could not fulfill the request due to internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '502': description: There is a bad gateway connection from the client to the server. '503': description: The server is (temporarily) unavailable. '504': description: The server did not respond inside time restrictions and time-out. 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. /dna/intent/api/v1/healthScoreDefinitions: get: tags: - systemIssueAndHealthScoreDefinitions summary: Get all health score definitions for given filters. description: 'Get all health score defintions. Supported filters are id, name and overall health include status. A health score definition can be different across device type. So, deviceType in the query param is important and default is all device types. By default all supported attributes are listed in response. ' operationId: readHealthDefinitions parameters: - name: deviceType in: query description: These are the device families supported for health score definitions. If no input is made on device family, all device families are considered. required: false style: form explode: true schema: type: string enum: - Router - Core, Distribution & Access - Wireless Controller - Access Point - Wireless Client - Wired Client - name: id in: query description: 'The definition identifier. Examples: id=015d9cba-4f53-4087-8317-7e49e5ffef46 (single entity id request) id=015d9cba-4f53-4087-8317-7e49e5ffef46&id=015d9cba-4f53-4087-8317-7e49e5ffef47 (multiple ids in the query param) ' required: false style: form explode: true schema: type: string format: uuid - name: includeForOverallHealth in: query description: The inclusion status of the issue definition, either true or false. true indicates that particular health metric is included in overall health computation, otherwise false. By default it's set to true. required: false style: form explode: true schema: type: string default: 'false' - name: attribute in: query description: 'These are the attributes supported in health score definitions response. By default, all properties are sent in response. ' required: false style: form explode: true schema: type: array items: type: string enum: - definitionStatus - description - deviceFamily - id - includeForOverallHealth - name - synchronizeToIssueThreshold - thresholdValue - 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: limit in: query description: Maximum number of records to return schema: minimum: 1 type: integer default: 500 - 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: Response object for the list of health score definitions. content: application/json: schema: $ref: '#/components/schemas/HealthScoreDefinitionListResponse' example: response: - id: 015d9cba-4f53-4087-8317-7e49e5ffef47 name: cpuUtilizationThreshold displayName: CPU Utilization deviceFamily: Router description: CPU Utilization includeForOverallHealth: true definitionStatus: DEFAULT thresholdValue: 90 synchronizeToIssueThreshold: true lastModified: '' version: '1.0' page: limit: 10 offset: 1 count: 20 sortBy: - name: name order: asc '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' '401': description: The client's authentication credentials included with the request are missing or invalid. '403': description: The server recognizes the authentication credentials, but the client is not authorized to perform this request. '406': description: The client requested a response in a content format that this server does not support. '500': description: The server could not fulfill the request due to internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '502': description: There is a bad gateway connection from the client to the server. '503': description: The server is (temporarily) unavailable. '504': description: The server did not respond inside time restrictions and time-out. 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. /dna/intent/api/v1/healthScoreDefinitions/{id}: get: tags: - systemIssueAndHealthScoreDefinitions summary: Get health score definition for the given id. description: "Get health score defintion for the given id. Definition includes all properties from HealthScoreDefinition schema by default. \n" operationId: readHealthDefinitionById parameters: - name: id in: path description: Health score definition id. required: true style: simple explode: false schema: type: string format: uuid - 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: Response object for a specific health score definition. content: application/json: schema: $ref: '#/components/schemas/HealthScoreDefinitionResponse' example: response: id: 015d9cba-4f53-4087-8317-7e49e5ffef47 name: cpuUtilizationThreshold displayName: CPU Utilization deviceFamily: Router description: CPU Utilization includeForOverallHealth: true definitionStatus: DEFAULT thresholdValue: 90 synchronizeToIssueThreshold: true lastModified: '' version: '1.0' '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' '401': description: The client's authentication credentials included with the request are missing or invalid. '403': description: The server recognizes the authentication credentials, but the client is not authorized to perform this request. '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' '501': description: The server has not implemented the functionality required to fulfill the request. '502': description: There is a bad gateway connection from the client to the server. '503': description: The server is (temporarily) unavailable. '504': description: The server did not respond inside time restrictions and time-out. 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. put: tags: - systemIssueAndHealthScoreDefinitions summary: Update health score definition for the given id. description: 'Update health threshold, include status of overall health status. And also to synchronize with global profile issue thresholds of the definition for given id. ' operationId: putHealthDefinitionById parameters: - name: id in: path description: Health score definition id. required: true style: simple explode: false schema: type: string format: uuid - 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: Update health score definition for the given id. content: application/json: schema: $ref: '#/components/schemas/HealthScoreDefinition' example: deviceFamily: Router includeForOverallHealth: true thresholdValue: 90 synchronizeToIssueThreshold: true lastModified: '' required: true responses: '200': description: Response object for a specific health score definition. content: application/json: schema: $ref: '#/components/schemas/HealthScoreDefinitionResponse' example: response: id: 015d9cba-4f53-4087-8317-7e49e5ffef47 name: cpuUtilizationThreshold displayName: CPU Utilization deviceFamily: Router description: CPU Utilization includeForOverallHealth: true definitionStatus: DEFAULT thresholdValue: 90 synchronizeToIssueThreshold: true lastModified: '' version: '1.0' '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' '401': description: The client's authentication credentials included with the request are missing or invalid. '403': description: The server recognizes the authentication credentials, but the client is not authorized to perform this request. '404': description: The client made a request for a resource that does not exist. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '405': description: The client made a request using an http method which is not supported for this resource. '406': description: The client requested a response in a content format that this server does not support. '415': description: The client sent a request body in a format that the server does not support (for example, XML to a server that only accepts JSON). '500': description: The server could not fulfill the request due to internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '501': description: The server has not implemented the functionality required to fulfill the request. '502': description: There is a bad gateway connection from the client to the server. '503': description: The server is (temporarily) unavailable. '504': description: The server did not respond inside time restrictions and time-out. 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. /dna/intent/api/v1/healthScoreDefinitions/bulkUpdate: post: tags: - systemIssueAndHealthScoreDefinitions summary: Update health score definitions. description: "Update health thresholds, include status of overall health status for each metric.\n\nAnd also to synchronize with global profile issue thresholds of the definition for given metric. \n" operationId: postHealthDefinitions 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: Update health score definition for the given id. content: application/json: schema: type: array items: $ref: '#/components/schemas/HealthScoreDefinition' example: - id: 015d9cba-4f53-4087-8317-7e49e5ffef47 deviceFamily: Router includeForOverallHealth: true thresholdValue: 90 synchronizeToIssueThreshold: true lastModified: '' required: true responses: '200': description: Response object for the list of health score definitions. content: application/json: schema: $ref: '#/components/schemas/HealthScoreDefinitionListWithoutPaginationResponse' example: response: - id: 015d9cba-4f53-4087-8317-7e49e5ffef47 name: cpuUtilizationThreshold displayName: CPU Utilization deviceFamily: Router description: CPU Utilization includeForOverallHealth: true definitionStatus: DEFAULT thresholdValue: 90 synchronizeToIssueThreshold: true lastModified: '' version: '1.0' '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' '401': description: The client's authentication credentials included with the request are missing or invalid. '403': description: The server recognizes the authentication credentials, but the client is not authorized to perform this request. '404': description: The client made a request for a resource that does not exist. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '405': description: The client made a request using an http method which is not supported for this resource. '406': description: The client requested a response in a content format that this server does not support. '415': description: The client sent a request body in a format that the server does not support (for example, XML to a server that only accepts JSON). '500': description: The server could not fulfill the request due to internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '501': description: The server has not implemented the functionality required to fulfill the request. '502': description: There is a bad gateway connection from the client to the server. '503': description: The server is (temporarily) unavailable. '504': description: The server did not respond inside time restrictions and time-out. 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. /dna/intent/api/v1/healthScoreDefinitions/count: get: tags: - systemIssueAndHealthScoreDefinitions summary: Get the count of health score definitions based on provided filters. description: 'Get the count of health score definitions based on provided filters. Supported filters are id, name and overall health include status. ' operationId: readHealthDefinitionsCount parameters: - name: deviceType in: query description: These are the device families supported for health score definitions. If no input is made on device family, all device families are considered. required: false style: form explode: true schema: type: string enum: - Router - Core, Distribution & Access - Wireless Controller - Access Point - Wireless Client - Wired Client - name: id in: query description: 'The definition identifier. Examples: id=015d9cba-4f53-4087-8317-7e49e5ffef46 (single entity id request) id=015d9cba-4f53-4087-8317-7e49e5ffef46&id=015d9cba-4f53-4087-8317-7e49e5ffef47 (multiple ids in the query param) ' required: false style: form explode: true schema: type: string format: uuid - name: includeForOverallHealth in: query description: The inclusion status of the issue definition, either true or false. true indicates that particular health metric is included in overall health computation, otherwise false. By default it's set to true. required: false style: form explode: true schema: type: string default: 'false' - 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/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' '401': description: The client's authentication credentials included with the request are missing or invalid. '403': description: The server recognizes the authentication credentials, but the client is not authorized to perform this request. '406': description: The client requested a response in a content format that this server does not support. '500': description: The server could not fulfill the request due to internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '502': description: There is a bad gateway connection from the client to the server. '503': description: The server is (temporarily) unavailable. '504': description: The server did not respond inside time restrictions and time-out. 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. components: schemas: IssueTriggerDefinitionResponse: type: object properties: response: $ref: '#/components/schemas/IssueTriggerDefinition' version: type: string example: '1.0' description: Response object for issue trigger definition. IssueDeviceType: type: string description: These are the device types supported for issue trigger definitions. enum: - Router - Switch and Hub - Wireless Controller - Unified AP - Wireless Client - Wired Client - Application - Sensor - Third Party Device ErrorResponse: title: Error Response type: object properties: response: type: array items: $ref: '#/components/schemas/ErrorObject' version: type: string description: The version of the response example: '1.0' description: Contains information explaining the error that occured processing this request. example: response: - errorCode: 2600 message: Error message detail: Error details externalDocs: description: Error Codes - Cisco DevNet url: https://developer.cisco.com/docs/dna-center/#!api-quick-start/error-codes HealthDeviceType: type: string description: These are the device type supported for health score definitions. readOnly: true enum: - Router - Switch and Hub - Wireless Controller - Unified AP - Wireless Client - Wired Client CountIntegerResponse: title: Count Integer Response type: object properties: response: $ref: '#/components/schemas/CountIntegerResponse_response' version: type: string description: The version of the response example: '1.0' description: Reports PaginationResponse_sortBy: type: object properties: name: type: string description: Field name by which sort is requested example: siteHierarchy order: type: string description: Sort order. 'asc' for ascending and 'desc' for descending example: asc enum: - asc - desc description: List of field names and corresponding order used to sort the records. CountIntegerResponse_response: type: object properties: count: type: integer description: The total number of records related to the resource format: int64 example: 1000 IssueCategory: type: string description: 'Category of the issue trigger definition. Indicates intent of grouped issues. To be more precise link related issues are grouped under connectivity. Example: WAN Interface Down is part of Connectivity category under Switches And Hubs device type. ' readOnly: true enum: - Connectivity - Connected - Device - Availability - System - Onboarding - Utilization - Application - Sensor Test - AP Anomaly HealthScoreDefinitionResponse: type: object properties: response: $ref: '#/components/schemas/HealthScoreDefinition' version: type: string example: '1.0' description: Response object for list of health score definitions. ErrorObject: type: object properties: errorCode: type: integer description: Application specific error code returned by the server message: type: string description: Brief message about the error condition detail: type: string description: A more detailed explanation of the error condition the parameter and its value, that caused the condition and why it caused it. IssueTriggerDefinitionListResponse: type: object properties: response: type: array items: $ref: '#/components/schemas/IssueTriggerDefinition' version: type: string example: '1.0' page: $ref: '#/components/schemas/PaginationResponse' example: response: - id: 015d9cba-4f53-4087-8317-7e49e5ffef46 displayName: Network Device Interface Connectivity - ISIS Adjacency Failure name: isis_adjacency_failure deviceFamily: Router description: ISIS Adjacency failed on Device. priority: P2 defaultPriority: P3 deviceType: Router issueEnabled: true profileId: global definitionStatus: CUSTOM categoryName: Connectivity synchronizeToHealthThreshold: false thresholdValue: 90 - id: 015d9cba-4f53-4087-8317-7e49e5ffef47 displayName: Network Device Interface Connectivity - ISIS Adjacency Failure name: isis_adjacency_failure deviceFamily: Switch And Hub description: ISIS Adjacency failed on Device. priority: P2 defaultPriority: P2 deviceType: Switch And Hub issueEnabled: true profileId: global definitionStatus: DEFAULT categoryName: Connectivity synchronizeToHealthThreshold: false thresholdValue: 90 version: '1.0' page: offset: 5 limit: 10 sortBy: name order: asc HealthScoreDefinitionListWithoutPaginationResponse: type: object properties: response: type: array items: $ref: '#/components/schemas/HealthScoreDefinition' version: type: string example: '1.0' HealthScoreDefinitionListResponse: type: object properties: response: type: array items: $ref: '#/components/schemas/HealthScoreDefinition' version: type: string example: '1.0' page: $ref: '#/components/schemas/PaginationResponse' IssueTriggerDefinition: type: object properties: id: type: string description: Issue trigger definition identifier. format: uuid readOnly: true example: 015d9cba-4f53-4087-8317-7e49e5ffef46 name: type: string description: Issue trigger name used internally. readOnly: true example: isis_adjacency_failure displayName: type: string description: Issue trigger name for display purposes. readOnly: true example: Network Device Interface Connectivity - ISIS Adjacency Failure description: type: string description: Description of issue trigger definition. readOnly: true example: ISIS Adjacency failed on Device. priority: $ref: '#/components/schemas/Priority' defaultPriority: readOnly: true allOf: - $ref: '#/components/schemas/Priority' deviceType: $ref: '#/components/schemas/IssueDeviceType' issueEnabled: type: boolean description: 'Issue trigger enabled or disabled. `false` indicates that no issues are needed to be generated for this definition. Example: if `isis_adjacency_failure` is disabled, no `isis_adjacency_failure` issues are generated for given profile and device type. ' default: true profileId: type: string description: Id of network design profile of type assurance. Please refer to network design profile documentation for more details. readOnly: true example: c88a2547-551b-4d30-bfd2-bec068336fdd default: global definitionStatus: type: string description: Status of the issue trigger definition. readOnly: true default: DEFAULT enum: - CUSTOM - DEFAULT categoryName: $ref: '#/components/schemas/IssueCategory' synchronizeToHealthThreshold: type: boolean description: Indicates to synchronize with health score definition. Applicable only to `global` profile issue trigger definition. thresholdValue: type: number description: 'Threshold value for given issue trigger. Example: CPU Utilization threshold > 90 indicates system needs to generate issue when CPU Utilization crosses 90%. ' example: 90 lastModified: type: string description: 'Last modification time. This is applicable for modified threshold in epoch format, by default it will be empty. ' readOnly: true description: Issue trigger definition. HealthScoreDefinition: type: object properties: id: type: string description: Health score definition id. format: uuid readOnly: true example: 015d9cba-4f53-4087-8317-7e49e5ffef47 name: type: string description: Health score definition name. readOnly: true example: cpuUtilizationThreshold displayName: type: string description: Health score definition name for display purposes. readOnly: true example: CPU Utilization deviceFamily: $ref: '#/components/schemas/HealthDeviceType' description: type: string description: Description of the health score definition. readOnly: true example: CPU Utilization includeForOverallHealth: type: boolean description: "Flag to indicate whether the KPI is included for overall health calulations or not. \n" default: true definitionStatus: type: string description: Status of the health score definition. readOnly: true default: DEFAULT enum: - CUSTOM - DEFAULT thresholdValue: type: number description: 'Threshold value to determine whether health is good or bad. Example: cpuUtilizationThreshold > 90, makes health score for device 1/poor if it exceeds cpu utilization 90%. ' example: 90 synchronizeToIssueThreshold: type: boolean description: 'Flag to indicate whether to synchronize with assurance issue trigger definitions. Applicable only to global profile issue trigger definitions. ' default: false lastModified: type: string description: 'Last modification time. This is applicable for modified threshold in epoch format, by default it will be empty. ' readOnly: true description: Health score definition. Priority: type: string description: 'Issue priority, possible values are P1, P2, P3, P4. `P1`: A critical issue that needs immediate attention and can have a wide impact on network operations. `P2`: A major issue that can potentially impact multiple devices or clients. `P3`: A minor issue that has a localized or minimal impact. `P4`: A warning issue that may not be an immediate problem but addressing it can optimize the network performance. ' enum: - P1 - P2 - P3 - P4 PaginationResponse: type: object properties: limit: type: integer description: The reference to the limit applied in the Pagination Request. example: 10 offset: type: integer description: The reference to the record offset applied in the Pagination Request. example: 1 count: type: integer description: Total number of records related to the resource after applying applicable filtering example: 20 sortBy: type: array description: Reference to the sortBy that was applied in the Pagination Request. items: $ref: '#/components/schemas/PaginationResponse_sortBy' externalDocs: description: Catalyst Center Developer API resources url: https://developer.cisco.com/dnacenter/