Product Alerts

Product Alerts API provides information on the latest product alerts for a given partner/customer/inventory. The End of Life (EoL) service provides access to Cisco EoL product data. Customers and partners can request Cisco EoL product information for both hardware and software using a combination of input parameters. The Field Notice and Security Advisory API provides information on hardware and software issues involving Cisco products.

Features

The Cisco Product Information API provides the following features:

• Supports RESTful interface, using a RAML definition file.
• Supports JSON data format
• Includes web services that return:
  • Field Notice information for a specific device or set of devicess.
  • Field Notice Bulletin details associated with a field notice.
  • Hardware End of Life details for a specific hardware device or set of devices.
  • Hardware Bulletins detail for the associated hardware device.
  • Security Vulnerability information including the Common Vulnerability and Exposure (CVE) identifiers and Common Vulnerability Scoring System (CVSS) for devices associated with customer ID.
  • Security Advisory bulletins detail for one or more security advisory IDs associated with the devices.
  • System Software End of Life details for a specific hardware device or set of devices.
  • System Software End of Life Bulletins detail for device(s) in the customer’s inventory

Field Notice

The Field Notice API returns details for all active Field Notice vulnerabilities on devices associated with the specified customer ID. All request parameters are optional other than “customerId”.

If "neInstanceId" is not provided as part of the request, the response will contain field notice information for all devices in the inventory of the specified customer.

This API supports filtering, pagination, sorting and chunked transfer encoding. For more information, see the General API Feature section for examples and features that allow you to optimize and manipulate the response.

URL

GET : https://apix.cisco.com/cs/api/v1/product-alerts/field-notices

Request Parameters

Response Parameters

Sample Request

https://apix.cisco.com/cs/api/v1/product-alerts/field-notices?customerId=1234

Sample JSON Response

{
  "data": [
    {
        "customerId": 1234,
        "neInstanceId": 54630957,
        "managedNeInstanceId": 23493614,
        "vulnerabilityStatus": "POTVUL",
        "vulnerabilityReason": "Missing TAN Match on Product ID, Serial Number,(Manual Verification Required).",
        "hwInstanceId": 54643639,
        "bulletinNumber": 63390
    }
  ]
}

Field Notice Bulletins

The field-notice-bulletins API retrieves field notice bulletin details for devices. All request parameters are optional.

If bulletin number is not provided as part of the request, the response will contain field notice information for all devices.

This API supports filtering, pagination, sorting and chunked transfer encoding. For more information, see the General API Feature section for examples and features that allow you to optimize and manipulate the response.

URL

GET : https://apix.cisco.com/cs/api/v1/product-alerts/field-notice-bulletins

Request Parameters

Response Parameters

Sample Request

https://apix.cisco.com/cs/api/v1/product-alerts/field-notice-bulletins

Sample JSON Response

{
  "data": [
    {
        "bulletinFirstPublished": "2001-10-31",
        "bulletinNumber": 14967,
        "fieldNoticeType": null,
        "bulletinTitle": "NPE-200 Fails to Boot IOS in Certain 7204VXR & 7206VXR Chassis",
        "bulletinLastUpdated": "2006-10-11",
        "alertAutomationCaveat": null,
        "url": "http://www.cisco.com/en/US/ts/fn/100/fn14967.html",
        "bulletinSummary": "AP1250"
    }
  ]
}

Hardware End Of Life

The Hardware End-of-Life API retrieves end of life details for a specific hardware device. All request parameters are optional other than “customerId”.

If "neInstanceId" is not provided in the request, the response will contain end of life information for all devices in the customer’s inventory.

This API supports filtering, pagination, sorting and chunked transfer encoding. For more information, see the General API Feature section for examples and features that allow you to optimize and manipulate the response.

URL

GET : https://apix.cisco.com/cs/api/v1/product-alerts/hardware-eol

Request Parameters

Response Parameters

Sample Request

https://apix.cisco.com/cs/api/v1/product-alerts/hardware-eol?customerId=1234

Sample JSON Response

{
  "data": [
    {
        "customerId": 1234,
        "neInstanceId": 52219050,
        "managedNeInstanceId": 23493670,
        "hwType": "Module",
        "currentHwEolMilestone": "EXTERNAL_ANNOUNCE_DATE",
        "nextHwEolMilestone": "END_OF_SALE_DATE",
        "hwInstanceId": 52227056,
        "productId": "N77-F248XP-23E",
        "currentHwEolMilestoneDate": "2016-10-31",
        "nextHwEolMilestoneDate": "2017-10-31",
        "hwEolInstanceId": 323776
    }
  ]
}

Hardware End Of Life Bulletins

The API returns end of life bulletin details for specific hardware device. All request parameters are optional.

If hardware end of life ID is not provided in the request, the response will contain end of life bulletin information on all hardware end of life and for all devices

This API supports filtering, pagination, sorting and chunked transfer encoding. For more information, see the General API Feature section for examples and features that allow you to optimize and manipulate the response.

URL

GET : https://apix.cisco.com/cs/api/v1/product-alerts/hardware-eol-bulletins

Request Parameters

Response Parameters

Sample Request

`https://apix.cisco.com/cs/api/v1/product-alerts/hardware-eol-bulletins

Sample JSON Response

{
  "data": [.
    {
        "hwEolInstanceId": 322397,
        "bulletinProductId": "CISCO2921/K9",
        "bulletinNumber": "EOL11158",
        "bulletinTitle": "Cisco 2900 Series Integrated Services Routers",
        "eoLifeAnnouncementDate": "2020-12-09",
        "eoSaleDate": "2017-12-09",
        "lastShipDate": "2018-03-09",
        "eoSwMaintenanceReleasesDate": null,
        "eoRoutineFailureAnalysisDate": "2018-12-09",
        "eoNewServiceAttachmentDate": "2018-12-09",
        "eoServiceContractRenewalDate": "2022-03-09",
        "lastDateOfSupport": "2022-12-31",
        "eoVulnerabilitySecuritySupport": null,
        "url": "http://www.cisco.com/c/en/us/products/collateral/routers/2900-series-integrated-services-routers-isr/eos-eol-notice-c51-737831.html"
    }
  ]
}

Security Advisory

The PSIRT API returns security vulnerability information including the Common Vulnerability and Exposure (CVE) identifiers and Common Vulnerability Scoring System (CVSS) for devices associated with customer ID. All request parameters are optional other than “customerId”.

If device ID is not provided in the request, the response will contain security advisory information for all device IDs associated with the customer.

This API supports filtering, pagination, sorting and chunked transfer encoding. For more information, see the General API Feature section for examples and features that allow you to optimize and manipulate the response.

URL

GET : https://apix.cisco.com/cs/api/v1/product-alerts/security-advisories

Request Parameters

Response Parameters

Sample Request

https://apix.cisco.com/cs/api/v1/product-alerts/security-advisories?customerId=1234

Sample JSON Response

{
  "data": [
    {
        "customerId": 1234,
        "neInstanceId": 53590367,
        "managedNeInstanceId": 23493691,
        "hwInstanceId": 53590416,
        "vulnerabilityStatus": "POTVUL",
        "vulnerabilityReason": " Match on SW Type, SW Version, Imagename,Missing Config",
        "securityAdvisoryInstanceId": 709
    }
  ]
}

Security Advisory Bulletins

The Security Advisory Bulletins API returns security advisory bulletin details for one or more security advisory IDs associated with the devices. All request parameters are optional.

If a security advisory ID is not provided in the request, the response will contain security advisory bulletin information for all active security advisories.

This API support filtering, pagination, sorting and chunked transfer encoding. For more information, see the General API Feature section to refer examples and features in order to optimize and manipulate the response.

URL

GET : https://apix.cisco.com/cs/api/v1/product-alerts/security-advisory-bulletins

Request Parameters

Response Parameters

Sample Request

https://apix.cisco.com/cs/api/v1/product-alerts/security-advisory-bulletins

Sample JSON Response

{
  "data": [
    {
        "securityAdvisoryInstanceId": 557,
        "url": "http://tools.cisco.com/security/center/content/CiscoSecurityAdvisory/cisco-sa-20150722-tftp",
        "bulletinVersion": 1.2,
        "advisoryId": "cisco-sa-20150722-tftp",
        "bulletinTitle": "Cisco IOS Software TFTP Server Denial of Service Vulnerability",
        "bulletinFirstPublished": "2014-12-28",
        "bulletinLastUpdated": "2014-12-28",
        "securityImpactRating": "High",
        "bulletinSummary": "A vulnerability in the TFTP server feature of Cisco IOS and Cisco IOS XE Software could allow an unauthenticated, remote attacker to cause a denial of service (DoS) condition. The TFTP server feature is not enabled by default. Cisco has released software updates that address this vulnerability. Workarounds that mitigate this vulnerability are available.",
        "alertAutomationCaveat": null,
        "cveId": 2007-4285,
        "cvssBaseScore": 8.0,
        "cvssTemporalScore": 6.6,
        "ciscoBugIds": "CSCvi76901"
    }
  ]
}

Software End Of Life

The Software End-of-Life API returns system software end of life details for a specific hardware device. All request parameters are optional other than “customerId”.

If "neInstanceId" is not provided in the request, the response will contain software end of life information for all devices in the inventory of the specified customer.

This API supports filtering, pagination, sorting and chunked transfer encoding. For more information, see the General API Feature section for examples and features that allow you to optimize and manipulate the response.

URL

GET : https://apix.cisco.com/cs/api/v1/product-alerts/software-eol

Request Parameters

Response Parameters

Sample Request

https://apix.cisco.com/cs/api/v1/product-alerts/software-eol?customerId=1234

Sample JSON Response

{
  "data": [
    {
        "customerId": 1234,
        "neInstanceId": 52817401,
        "managedNeInstanceId": 23493685,
        "swType": "TC",
        "currentSwEolMilestone": "END_OF_SALE_DATE",
        "nextSwEolMilestone": "SOFTWARE_MAINT_END_DATE",
        "swVersion": "TC7.3.9",
        "currentSwEolMilestoneDate": "2017-08-02",
        "nextSwEolMilestoneDate": "2020-08-01",
        "swEolInstanceId": 781
    }
  ]
}

Software End Of Life Bulletins

The software-EOL-bulletins API retrieves end of life bulletin details for the device(s). All request parameters are optional.

If software end of life ID is not provided in the request, the response will contain software end of life information for all devices.

This API supports filtering, pagination, sorting and chunked transfer encoding. For more information, see the General API Feature section for examples and features that allow you to optimize and manipulate the response.

URL

GET : https://apix.cisco.com/cs/api/v1/product-alerts/software-eol-bulletins

Request Parameters

Response Parameters

Sample Request

`https://apix.cisco.com/cs/api/v1/product-alerts/software-eol-bulletins

Sample JSON Response

{
  "data": [
    {
        "swEolInstanceId": 451,
        "bulletinNumber": "EOL8836",
        "swType": "IOS",
        "bulletinTitle": "Cisco IOS XE Software Release 3.4S",
        "swMajorVersion": null,
        "swMaintenanceVersion": null,
        "swTrain": null,
        "eoLifeAnnouncementDate": null,
        "eoSaleDate": "2013-03-28",
        "eoSwMaintenanceReleasesDate": null,
        "eoVulnerabilitySecuritySupport": null,
        "lastDateOfSupport": "2018-03-31",
        "url": "http://www.cisco.com/en/US/prod/collateral/routers/ps9343/end_of_life_notice_c51-717501.html"
    }
  ]
}