Product Alerts

Config BP By Network Element Trend API

Config BP By Network Element Trend API shows the trend of Configuration Best Practices (CBP) averge exceptions in the network. The input parameters specify the number of data points and whether the trend is to be shown for weekly or monthly intervals. For each data point the API returns the average number of CBP exceptions per device and the corresponding timestamp. The average is calculated by dividing the total number of devices in the network having configurations to which CBP rules apply into the total number of CBP exceptions in the network (All CBP Exceptions)/ (Total devices)

Request URL

GET : https://apx.cisco.com/cs/api/v1/product-alerts/config-bp-by-network-element-trend

Request Parameters

Note- Data display is subjected to data availability.

Response Parameters

Sample JSON Response

{
    "data": [
        {
            "interval": "2018-07-01",
            "averageExceptionCount": "28"
        },
        {
            "interval": "2018-08-01",
            "averageExceptionCount": "28"
        },
        {
            "interval": "2018-09-01",
            "averageExceptionCount": "28"
        },
        {
            "interval": "2018-10-01",
            "averageExceptionCount": "28"
        }
    ]
}

Config BP By Risk Trend API

Config BP By Risk Trend API provides the trend of all CBP exceptions in each risk level. The input parameters specify the number of data points and whether the trend is for weekly or monthly intervals. An optional Technology parameter will limit the data to a given technology or return data for all technologies be default. For each data point the API returns a timestamp and the count of exceptions in the High, Medium, and Low risk rating corresponding to that time.

Request URL

GET : https://apx.cisco.com/cs/api/v1/product-alerts/config-bp-by-risk-trend

Request Parameters

Note- Data display is subjected to data availability.

Response Parameters

Sample JSON Response

{
    "data": [
        {
            "risks": [
                {
                    "exceptionCount": "0",
                    "risk": "High"
                },
                {
                    "exceptionCount": "0",
                    "risk": "Low"
                },
                {
                    "exceptionCount": "0",
                    "risk": "Medium"
                }
            ],
            "interval": "2018-04-01"
        },
        {
            "risks": [
                {
                    "exceptionCount": "0",
                    "risk": "High"
                },
                {
                    "exceptionCount": "0",
                    "risk": "Low"
                },
                {
                    "exceptionCount": "0",
                    "risk": "Medium"
                }
            ],
            "interval": "2018-05-01"
        }
    ]
}

Config BP By Technology Trend API

Config BP By Technology Trend API provides the trend of CBP exceptions by technology (referred as CBP category in older documents.) Those 5 technologies are considered which have the highest number of exceptions. The API returns a list of data points for each technology. Each data point shows a timestamp and the number of exceptions corresponding to that time for the given technology. This is repeated for all technologies that are included.

Request URL

GET : https://apx.cisco.com/cs/api/v1/product-alerts/config-bp-by-technology-trend

Request Parameters

Note- Data display is subjected to data availability.

Response Parameters

Sample JSON Response

{
    "data": [
        {
            "intervals": [
                {
                    "exceptionCount": "178",
                    "interval": "2018-09-01"
                },
                {
                    "exceptionCount": "178",
                    "interval": "2018-10-01"
                },
                {
                    "exceptionCount": "178",
                    "interval": "2018-08-01"
                },
                {
                    "exceptionCount": "178",
                    "interval": "2018-07-01"
                },
                {
                    "exceptionCount": "0",
                    "interval": "2018-04-01"
                },
                {
                    "exceptionCount": "0",
                    "interval": "2018-05-01"
                },
                {
                    "exceptionCount": "0",
                    "interval": "2018-06-01"
                }
            ],
            "technology": "IP"
        },
        {
            "intervals": [
                {
                    "exceptionCount": "72",
                    "interval": "2018-09-01"
                },
                {
                    "exceptionCount": "72",
                    "interval": "2018-10-01"
                },
                {
                    "exceptionCount": "71",
                    "interval": "2018-08-01"
                },
                {
                    "exceptionCount": "71",
                    "interval": "2018-07-01"
                },
                {
                    "exceptionCount": "0",
                    "interval": "2018-04-01"
                },
                {
                    "exceptionCount": "0",
                    "interval": "2018-05-01"
                },
                {
                    "exceptionCount": "0",
                    "interval": "2018-06-01"
                }
            ],
            "technology": "LAN Switching"
        }
    ]
}

Config BP Rule Trend API

Config BP Rule Trend API shows the trend of the unique CBP rules creating exceptions in the network. The input parameters specify the number of data points and whether the trend is for weekly or monthly intervals. An optional Technology parameter will limit the data to a given technology or return data for all technologies be default. For each data point the API returns a timestamp and the number of rules corresponding to that time.

Request URL

GET : https://apx.cisco.com/cs/api/v1/product-alerts/config-bp-rule-trend

Request Parameters

Note- Data display is subjected to data availability.

Response Parameters

Sample JSON Response

{
    "data": [
        {
            "ruleCount": "549",
            "interval": "2018-07"
        },
        {
            "ruleCount": "549",
            "interval": "2018-08"
        },
        {
            "ruleCount": "549",
            "interval": "2018-09"
        },
        {
            "ruleCount": "547",
            "interval": "2018-10"
        }
    ]
}

Custom Config Summary By Template API

Custom Config Summary By Template API shows the conformance by custom configuration templates. An optional input parameter, if provided, will limit the data to a given template otherwise it returns data for all templates. It returns a list of values where each item in the list contains the name of the template and the percentage conformance. Conformance is the ratio of the number of devices conforming to the configuration rules in a template to the total number of devices in that template.

Request URL

GET : https://apx.cisco.com/cs/api/v1/product-alerts/custom-config-summary-by-template

Request Parameters

Response Parameters

Sample JSON Response

{
    "data": [
        {
            "templateName": "http_server",
            "conformance" : "45"
    }
    ]
}

Custom Config Trend API

Custom Config Trend API shows the trend of the percent configuration conformance of each template over a period of time. By default all templates are shown by data can be limited to a single template specified as input parameter.

Request URL

GET : https://apx.cisco.com/cs/api/v1/product-alerts/custom-config-trend

Request Parameters

Note- Data display is subjected to data availability.

Response Parameters

Sample JSON Response

{
    "data": [
        {
            "intervals": [
                {
                    "conformance": "84.65",
                    "interval": "2018-09-01"
                },
                {
                    "conformance": "84.59",
                    "interval": "2018-10-01"
                }
            ],
            "templateName": "Nexus 5k7k Loopguard2"
        }
    ]
}

Hardware EOL Summary By Month API

Hardware EOL Summary By Month API retrieves all the hardware End of Life milestones in the past 3 months and the future 3 months. For each milestone, it returns a list showing the months in which that milestone occurs.

Request URL

GET : https://apx.cisco.com/cs/api/v1/product-alerts/hardware-eol-summary-by-month

Request Parameters

Response Parameters

Sample JSON Response

{
    "data": [
        {
            "month": "2018-09",
            "hwEolMilestone": "EoRFA",
            "bulletinCount": "8"
        },
        {
            "month": "2018-10",
            "hwEolMilestone": "EoSCR",
            "bulletinCount": "8"
        }
    ]
}

Hardware EOL Milestones By Product Family API

Hardware EOL Milestones By Product Family API retrieves all the hardware milestones in the past 3 months and future 3 months for all the chassis product families. User can change these defaults by selecting a different hardware type (Module, Power Supply, Fan) and can also get milestone for a single product family by specifying it as input parameter.

Request URL

GET : https://apx.cisco.com/cs/api/v1/product-alerts/hardware-eol-milestones-by-product-family

Request Parameters

Response Parameters

Sample JSON Response

{
  "data": [
    {
      "productFamily": "Cisco 2900 Series Integrated Services Routers",
      "month": "2018-12",
      "hwEolMilestone": "End of Routine Failure Analysis"
    }
  ]
}

Software EOL Summary By Milestone API

Software EOL Summary By Milestone API retrieves all the software End of Life milestones in the past 3 months and the future 3 months. For each milestone, it returns a list showing the months in which that milestone occurs.

Request URL

GET : https://apx.cisco.com/cs/api/v1/product-alerts/software-eol-summary-by-milestone

Request Parameters

Response Parameters

Sample JSON Response

{
    "data": [
        {
            "milestone": "End of Sale",
            "neCount": "8990"
        },
        {
            "milestone": "Last Day of Support",
            "neCount": "87"
        }
    ]
}

Field Notice Summary API

Field Notice Summary API returns the list of Field Notice bulletins creating vulnerabilities in the network. For each bulletin, the API returns the name, ID, first published date, and the number of devices where it is creating a vulnerability or a potential vulnerability.

Request URL

GET : https://apx.cisco.com/cs/api/v1/product-alerts/field-notice-summary

Request Parameters

Response Parameters

Sample JSON Response

{
  "data": [
    {
      "bulletinTitle": "FN70288-ISR-WAASDoesNotDeploySuccessfullyonanISR-4321RouterInstalledwithCiscoIOSXESoftwareRelease16.9.x-SoftwareUpgradeRecommended",
      "bulletinFirstPublished": "2018-09-03",
      "bulletinNumber": "70288",
      "neCount": "10"
    }
  ]
}

Field Notice Trend API

Field Notice Trend API shows the Field Notices trend by showing the count of FNs creating vulnerabilities over a period of time. The input parameters specify the number of data points and whether the trend is to be shown for weekly or monthly intervals. A set of data is returned, where each data point includes a timestamp, the count of FNs creating vulnerabilities, and the count of FNs creating potential vulnerabilities at that time. Note that if an FN is creating vulnerability in one or more devices and a potential vulnerability in one or more devices then that Field notice is considered vulnerable. If a field notice is creating one or more potential vulnerabilities but no vulnerability then only it is considered potentially vulnerable.

Request URL

GET : https://apx.cisco.com/cs/api/v1/product-alerts/field-notice-trend

Request Parameters

Response Parameters

Sample JSON Response

{
    "data": [
        {
            "trendPeriod": "2018-10-06",
            "potentiallyVulnerableFieldNotices": "72",
            "vulnerableFieldNotices": "8"
        },
        {
            "trendPeriod": "2018-09-29",
            "potentiallyVulnerableFieldNotices": "71",
            "vulnerableFieldNotices": "8"
        }
    ]
}

Security Advisory Summary API

Security Advisory Summary API returns the list of Security Advisories vulnerabilities in the network. For each Advisory, the API returns the name, ID, first published date, and the number of devices where it is creating a vulnerability or a potential vulnerability.

Request URL

GET : https://apx.cisco.com/cs/api/v1/product-alerts/security-advisory-summary

Request Parameters

Response Parameters

Sample JSON Response

{
  "data": [
    {
      "bulletinTitle": "Cisco IOS Software Precision Time Protocol Denial of Service Vulnerability",
      "bulletinFirstPublished": "2018-09-03",
      "securityAdvisoryInstanceId": "1044",
      "neCount": "25"
    }
  ]
}

Security Advisory Trend API

Security Advisory Trend API shows the Security Advisory trend by showing the count of Advisories creating vulnerabilities over a period of time. The input parameters specify the number of data points and whether the trend is to be shown for weekly or monthly intervals. A set of data is returned, where each data point includes a timestamp, the count of Advisories creating vulnerabilities, and the count of Advisories creating potential vulnerabilities at that time. Note that if an Advisory is creating vulnerability in one or more devices and a potential vulnerability in one or more devices then that Advisory is considered vulnerable. If an Advisory is creating one or more potential vulnerabilities but no vulnerability then only it is considered potentially vulnerable.

Request URL

GET : https://apx.cisco.com/cs/api/v1/product-alerts/security-advisory-trend

Request Parameters

Response Parameters

Sample JSON Response

{
    "data": [
        {
            "potentiallyVulnerableAdvisories": "160",
            "trendPeriod": "2018-10-06",
            "vulnerableAdvisories": "122"
        },
        {
            "potentiallyVulnerableAdvisories": "161",
            "trendPeriod": "2018-09-29",
            "vulnerableAdvisories": "122"
        }
    ]
}