At any point in time, you will see a list of supported APIs for your release version.

If necessary, click the angle icon, > to display the API subdomains.

After choosing an API, the following information is displayed in columns:

• Method: Supported methods include GET, POST, PUT, and DELETE.

• Name: Link to access the slide-in pane and additional information, including description, features, tags, parameters, responses, model schemas, and so on.

• Description: Brief description of method.

• URL: URL value for the method.

• Icon (…): Accesses links to create a code preview snippet or Try It option.

The following information about the API method is displayed:

• DESCRIPTION: Brief description of API.

• FEATURES: Method and URL information.

• TAGS: API identifiers, including where and under what circumstances you would use the API. Note that some APIs may not have tags.

• PARAMETERS: Parameters of API, including description, data type (boolean or string), default value, and required value.

• RESPONSES: Possible HTTP responses.

• MODEL SCHEMAS: Presents response as a data model (Model tab) or JSON format of the actual response (Model Schema tab). Sample code is available from the Code Preview button.

• POLICIES: An API rate limiting feature, where policies are applied to certain APIs. These policies set the number of API calls per time interval per client IP address.

The following languages are supported:

• Shell

• Node - HTTP

• Node - Unirest

• Node - Request

• Python

• Ruby

• JavaScript

• JQuery

• PHP

• Go

• Ansible

After reviewing or copying the code preview sample for use, click Close.

After reviewing the response and/or error code, click Close.

When Cisco DNA Center returns a 202 (Accepted) HTTP status code, the result body includes a task ID and a URL that you can use to query for more information about the asynchronous task that your original request spawned. For example, you can use this information to determine whether a lengthy task has completed. For more information, see Getting Information about Asynchronous Operations.

The following information is displayed:

• Name: Name of the integration flow and link to access a slide-in pane where additional information is available.

  If the integration flow is a REST based trigger type, after you click the integration flow name additional data such as description, tags, parameters, responses, model schemas, and policies appear.

  If the integration flow is a schedule based trigger type, after you click the integration flow name a slide-in pane for setting the schedule appears. This slide-in pane displays DESCRIPTION, TAGS, and HOW TO USE THIS FLOW content.

• Description: Brief description of integration flow.

• Trigger: REST-based or Schedule based.

• Icon (…): Accesses links to create a code preview or the Try It option. If the integration flow is schedule based, this icon accesses a Schedule Flow option.

A slide-in pane opens with details about the REST-based integration flow, You can review the details and then close the slide-in pane.

These choices appear only for REST-based triggered integration flows. Schedule based integration flows provide a Schedule Flow menu item on hover.

After reviewing or copying the code for use, click Close.

After trying the method, review the response and/or error code within the Try It window, and click Close.

When Cisco DNA Center returns a 202 (Accepted) HTTP status code, the result body includes a task ID and a URL that you can use to query for more information about the asynchronous task that your original request spawned. For example, you can use this information to determine whether a lengthy task has completed. For more information, see Getting Information about Asynchronous Operations.

• DESCRIPTION: Description and purpose of integration flow.

• TAGS: Tags indicate what the Cisco DNA Center component is used for or affected by the bundle.

• HOW TO USE THIS FLOW: Schedule configuration options.

You can schedule the integration flow using the GUI.

• Run Now: Choose Run Now and then click the Schedule button to run the integration flow.

• Run Later: Choose Run Later and then enter a date, time, and time zone. Click the Schedule button to run the integration flow at the specified date, time, and time zone.

• Recurring: Choose Recurring and then configure the following options:

  • Repeats: Choose daily or weekly repeating occurrences for the integration flow

  • Run at Interval: Set the time interval between integration flows.

  • Set Schedule Start: Set a start date.

  • Set Schedule End: Set an end date.

  Click the Schedule button to run the integration at the configured times.

The Events window appears.

The following Events data is provided:

• Event ID: Identification number for the event.

• Name: Name of the event (link).

  If you click this link, the Name slide-in pane opens for the event. The Name slide-in pane consists of two tabs: Events Details and Active Subscriptions.

• Description: Brief description of the event.

• Type: Network, App, System, Security, or Integrations type of event.

• Category: Error, Warn, Info, Alert, Task Progress, Task Complete.

• Severity: 1 through 5.

  Note	Severity 1 is the most important or critical priority and should be assigned for this type of an event.

• Status: Subscription status (whether a user has subscribed to the event). If subscribed to an event, then a link appears in this column to the Active Subscription tab.

The following Event Details tab data is displayed:

• Description: Brief description of the event and how it is triggered.

• Event ID: Identification number of the event.

• Version: Version number of the event.

• Namespace: Namespace of the event.

  The default value for this release for all of the events is ASSURANCE.

• Domain: REST API domain to which the event belongs.

• Sub Domain: Subgroup under the REST API domain to which the event belongs.

• Type: Network, App, System, Security, or Integrations type of event.

• Category: Error, Warn, Info, Alert, Task Progress, Task Complete.

• Severity: 1 through 5.

  Note	Severity 1 is the most important or critical priority and should be assigned for this type of an event.

• Cisco DNA Event Link: Event broadcast using REST URL.

• Note: Additional information about the event or to assist in further understanding the event.

• Tenant Aware: Whether the event is tenant aware or not.

• Tags: Tags indicate what Cisco DNA Center component is affected by the event. The default value for tags for this release is ASSURANCE with additional syntax for the specific Assurance issue.

• Supported Endpoints: What endpoint types are supported for the event notifications. The following endpoints are supported with this release:

  • REST API

  • Syslog server

  • Email

  • SNMP trap

  • PagerDuty

• Model Schema: Presents model schema about the event:

  • Details: Example of model schema detail for the event.

  • REST Schema: REST schema format for the event.

The following Active Subscriptions tab data is displayed:

• Broadcast Methods: Email, REST API, syslog server, SNMP trap, or PagerDuty

• Count and Instances: Number of instances of notifications for emails, REST APIs, syslog server, SNMP traps, or PagerDuty.

  Note

  After subscribing to an event, click the subscription count (>) under Count and Instances to edit or unsubscribe to the active subscription. After clicking the individual subscription count (>), click Unsubscribe to unsubscribe or Edit to further edit it. For multiple subscriptions, you will need to unsubscribe to each subscription one at time. The ability for multiple subscribing or unsubscribing is not supported using the GUI.

• Actions: Either unsubscribe or edit the active subscription.

  Note	After subscribing to an event, a Try It button will appear in the Active Subscriptions tab. By clicking on this button, you are able to run an event simulation. For information about this feature Work with Event Simulations.

• Name: Name of the event.

• Subscription Type: SYSLOG

  Click the link to access the Syslog GUI window and configure a new endpoint (syslog server hostname and port number).

  Note

  Subscription type can be set for either email, REST API endpoint, syslog server, SNMP trap, or PagerDuty. If you select SYSLOG, but have not yet configured the syslog server settings, you are prompted to access the GUI window where you can perform this task. Syslog server settings are configured in the Syslog tab. You can also access this tab, by clicking System > Settings > External Services > Destinations > Syslog tab.

Click Subscribe to save and enable the subscription or Cancel to cancel and exit the window.

• Name: Name of the event.

• Subscription Type: REST

  Click the link to access the Webhook GUI window and configure a new webhook endpoint.

  Note

  Subscription type can be set for either email, REST API endpoint (webhook), syslog server, SNMP trap, or PagerDuty. If you select REST, but have not yet configured the webhook settings, you are prompted to access the GUI window where you can perform this task. Webhook settings are configured in the Webhook tab. You can also access this tab, by clicking System > Settings > External Services > Destinations > Webhook tab.

• Select an existing endpoint: Select the Subscription Endpoint and URL by using the drop-down arrow.

• Create a new endpoint: Click the link to access the Webhook GUI window and configure a new endpoint (Add Webhook).

  Note	When using this procedure, there is a one to one correspondence of a webhook endpoint to an event, but several different events can be configured to a single webhook endpoint by following this procedure multiple times.

Review the remainder of the REST configuration:

• URL: URL address of the REST API endpoint that event will be sent to.

• Trust certificate: Whether a trust certificate is required for REST API endpoint notification.

• HTTP Method: Either the PUT or POST method.

• Authentication: One of the following Authentication types:

  • Basic: Authentication where the client sends HTTP requests with the Authorization header that contains the word 'Basic', followed by a space and a base64-encoded string 'username:password'. If you select Basic in the GUI, the Headers field below enters the value Authorization.

  • Token: Authentication where users are authenticated using a security token provided by the server. If you select Token, the Headers field below enters the value X-Auth-Token.

  • No Authentication: No authentication needed.

• Headers: The Header Name and Header Value.

  Note	The Headers fields may be auto-populated depending upon your Authentication selection above.

Click Subscribe to save and enable the subscription or Cancel to cancel and exit the window.

• Name: Name of the event.

• Subscription Type: EMAIL

  Note

  Subscription type can be set for either email, REST API endpoint (webhook), syslog server, SNMP trap, or PagerDuty. If you select EMAIL, but have not yet configured the email settings, you are prompted to access the GUI window where you can perform this task. Email settings are configured in the Email tab. You can also access this tab, by clicking System > Settings > External Services > Destinations > Email tab.

• Select an existing endpoint: Select the Subscription Endpoint by using the drop-down arrow.

• Create a new endpoint: Enter a new Endpoint Name and Endpoint Description.

  Note	You can only create a new endpoint using pre-existing email settings configured in the Email tab, as described above.

Review the remainder of the EMAIL configuration:

• SMTP Configuration: Review the hostname/IP address, port number, username, and password for a primary and secondary SMTP server. The secondary SMTP server is optional.

• Email Recipients: Enter a From and To email address, and a Subject header for the email.

  Note

  Up to 20 email addresses can be configured per endpoint to receive an email. To enter an additional email address, after typing the first email address press <Enter> on your keyboard and type in the additional mail address. After pressing <Enter>. all the required validations for the email address are performed and you will be notified if there is anything wrong with the email address syntax. If more than 20 email addresses need to be configured for an endpoint, then an email alias can be used.

Click Subscribe to save and enable the subscription or Cancel to cancel and exit the window.

• Name: Name of the event.

• Subscription Type: SNMP

  Subscription type can be set for either email, REST API endpoint, SNMP trap, or PagerDuty.

  The SNMP trap notification is only available for a system hardware event. A system hardware event publishes notifications to any subscriber, when the health state of hardware components change. Hardware components monitored for changes include: CPU, Memory, Disk, NIC, fan, power supply, and RAID Controller.

• Select an existing endpoint: Select the Subscription Endpoint by using the drop-down arrow.

• Create a new endpoint: Click the link (here) to access the Trap GUI window and configure a new endpoint (Add).

• Hostname/IP Address: Enter the hostname/IP address for the SNMP trap receiver (server).

• Port: Enter the port number for the SNMP trap receiver (server).

• SNMP Version: Enter the SNMP version from the drop down menu for the community configuration.

  • SNMP V2C: For SNMP Version 2C, enter the community string.

  • SNMP V3: For SNMP Version 3, enter the following additional information:

    • Username

    • Mode: Authentication and Privacy, Authentication, No Privacy, or No Authentication, No Privacy

      • For No Authentication, No Privacy selection, no further configuration is required.

      • For Authentication, No Privacy, configure the Authentication Type (SHA or MD5 ), Authentication Password, Confirm Authentication Password.

      • For Authentication and Privacy, configure the Authentication Type (SHA or MD5 ), Authentication Password, Confirm Authentication Password, Additionally, configure the Privacy Type (AES128, DES), Privacy Password, and Confirm Privacy Password.

Click Subscribe to save and enable the subscription or Cancel to cancel and exit the window.

• Name: Name of the event.

• Subscription Type: PAGER_DUTY

  Note	Subscription type can be set for either email, REST API endpoint (webhook), syslog server, SNMP trap, or PagerDuty.

• Select an existing endpoint: Select the Subscription Endpoint by using the drop-down arrow.

• Create a new endpoint: Enter a new Endpoint Name and Endpoint Description.

Enter values for the following fields:

• PagerDuty Events API URL

• PagerDuty Integration Key

• PagerDuty Events API Version

Click Subscribe to save and enable the subscription or Cancel to cancel and exit the window.

The following information is provided for a subscription:

• Broadcast Method: Email, REST API, syslog server, SNMP trap or PagerDuty notification.

• Counts and Instances: Number of instances of notification.

  Click the Unsubscribe and Edit links to unsubscribe or edit the subscription respectively.

• Actions: Actions taken for the events.