Introduction

Overview

The Cisco EoX API provides access to Cisco End of Life product data. Using the EoX Service API, customers and partners can request Cisco EoX product information for both hardware and software using a variety of input mechanisms. For more information on Cisco EoX products and the EoX lifecycle, see Cisco End-of-Life Policy.

Note: With the exception of the PID input value, the Cisco EoX API methods do not accept wildcards. Values for request parameters must be exact. For example: "WIC-1T" and "WIC-1T=" are different PIDs that can yield different results.

Features

The Cisco EoX API provides the following features:

Supports RESTful interface
Supports JSON data format
Includes web services that return:
- End of Life product information for the specified date range
- End of Life product information for specified product ID(s)
- End of Life product information for specified serial number(s)
- End of Life product information for specified software release string(s)

API Reference

This topic describes the methods provided by this API.

Notes:

You can download the WADL for this API by clicking the following link: Cisco End-of-Life (EoX) API WADL
This API reference provides information related to the latest version of this API. Cisco encourages you to use the latest version of the Cisco Support APIs; however, if you use the legacy version of this API, refer to the Cisco Support Tools EoX Service API Reference for details.

Get EoX by Dates

Returns all active and inactive EoX records for all products with the specified eoxAttrib value within the startDate and endDate values, inclusive. If you do not specify an eoxAttrib value, this method returns records with an updated time stamp within the specified date range.

Note: This method can be used to retrieve records based on any date listed in the EoX record. For example, if you specify a date range and enter EO_SALE_DATE and EO_LAST_SUPPORT_DATE as the eoxAttrib values, this method returns records with an end of sale date or last date of support within the specified date range. This feature allows you to target specific date ranges within each attribute without having to pull the entire database.

URI

https://apix.cisco.com/supporttools/eox/rest/5/EOXByDates/{pageIndex}/{startDate}/{endDate}

Request Parameters

Parameter	Required	Type	Length	Description
pageIndex	No	integer	5	Index number of the page to return; a maximum of 50 records per page are returned.
startDate	Yes	string	10	Start date of the date range of records to return in the following format: YYYY-MM-DD. For example: 2010-01-01
endDate	Yes	string	10	End date of the date range of records to return in the following format: YYYY-MM-DD. For example: 2010-01-01
eoxAttrib	No	string	20	Attribute or attributes of the records to return. Enter multiple values separated by commas. eoxAttrib must be one of the following values: EO_EXT_ANNOUNCE_DATE EO_SALES_DATE EO_FAIL_ANALYSIS_DATE EO_SVC_ATTACH_DATE EO_SW_MAINTENANCE_DATE EO_SECURITY_VUL_SUPPORT_DATE EO_CONTRACT_RENEW_DATE EO_LAST_SUPPORT_DATE UPDATE_TIMESTAMP (default) See EOXRecordType for more information on these values.
responseencoding	No	string	4	Format in which you want the results to appear. Valid values are: xml and json.

Response Parameters

Parameter	Description
PaginationResponseRecord	Index number for the page requested and the total number of pages available to return. See PaginationResponseRecordType for more information.
EOXRecord	EoX information for the requested products. You can receive multiple EOX records for the same PID if that product includes multiple migration paths; see EOXRecordType for more information.

Sample XML Request

GET https://apix.cisco.com/supporttools/eox/rest/5/EOXByDates/1/2011-01-01/2015-12-31?responseencoding=xml

Sample XML Response

<eox:ShowEOXByDatesResponse xmlns:eox="https://www.cisco.com/services/ssapi/eox/1">
   <eox:PaginationResponseRecord>
      <eox:PageIndex>1</eox:PageIndex>
      <eox:LastIndex>3</eox:LastIndex>
      <eox:TotalRecords>2836</eox:TotalRecords>
      <eox:PageRecords>1000</eox:PageRecords>
   </eox:PaginationResponseRecord>
   <eox:EOXRecord>
      <eox:EOLProductID>CCX-80-A-QMS-LIC</eox:EOLProductID>
      <eox:ProductIDDescription>Quality Server</eox:ProductIDDescription>
      <eox:ProductBulletinNumber>EOL7523</eox:ProductBulletinNumber>
      <eox:LinkToProductBulletinURL>...</eox:LinkToProductBulletinURL>
      <eox:EOXExternalAnnouncementDate dateFormat="YYYY-MM-DD">2011-05-24</eox:EOXExternalAnnouncementDate>
      <eox:EndOfSaleDate dateFormat="YYYY-MM-DD">2011-11-22</eox:EndOfSaleDate>
      <eox:EndOfSWMaintenanceReleases dateFormat="YYYY-MM-DD">2012-11-21</eox:EndOfSWMaintenanceReleases>
      <eox:EndOfSecurityVulSupportDate dateFormat="YYYY-MM-DD">2012-12-15</eox:EndOfSecurityVulSupportDate>
      <eox:EndOfRoutineFailureAnalysisDate dateFormat="YYYY-MM-DD"></eox:EndOfRoutineFailureAnalysisDate>
      <eox:EndOfServiceContractRenewal dateFormat="YYYY-MM-DD">2014-02-17</eox:EndOfServiceContractRenewal>
      <eox:LastDateOfSupport dateFormat="YYYY-MM-DD">2014-11-30</eox:LastDateOfSupport>
      <eox:EndOfSvcAttachDate dateFormat="YYYY-MM-DD">2012-11-21</eox:EndOfSvcAttachDate>
      <eox:UpdatedTimeStamp dateFormat="YYYY-MM-DD">2012-01-03</eox:UpdatedTimeStamp>
      <eox:EOXMigrationDetails>
         <eox:PIDActiveFlag>Y</eox:PIDActiveFlag>
         <eox:MigrationInformation></eox:MigrationInformation>
         <eox:MigrationOption>See Migration Section</eox:MigrationOption>
         <eox:MigrationProductId></eox:MigrationProductId>
         <eox:MigrationProductName></eox:MigrationProductName>
         <eox:MigrationStrategy>...</eox:MigrationStrategy>
         <eox:MigrationProductInfoURL>...</eox:MigrationProductInfoURL>
      </eox:EOXMigrationDetails>
      <eox:EOXInputType>showEoXByDates</eox:EOXInputType>
      <eox:EOXInputValue>2011-01-01 , 2015-12-31</eox:EOXInputValue>
   </eox:EOXRecord>
   <!-- Output suppressed. -->
</eox:ShowEOXByDatesResponse>

Sample JSON Request

GET https://apix.cisco.com/supporttools/eox/rest/5/EOXByDates/1/2011-01-01/2015-12-31?responseencoding=json

Sample JSON Response

{ 
  "PaginationResponseRecord": { 
    "PageIndex": 1, 
    "LastIndex": 3, 
    "TotalRecords": 2836, 
    "PageRecords": 1000 
  }, 
  "EOXRecord": [{ 
    "EOLProductID": "CCX-80-A-QMS-LIC", 
    "ProductIDDescription": "Quality Server", 
    "ProductBulletinNumber": "EOL7523", 
    "LinkToProductBulletinURL": "https://www.cisco.com", 
    "EOXExternalAnnouncementDate": { 
      "value": "2011-05-24", 
      "dateFormat": "YYYY-MM-DD" 
    }, 
    "EndOfSaleDate": { 
      "value": "2011-11-22", 
      "dateFormat": "YYYY-MM-DD" 
    }, 
    "EndOfSWMaintenanceReleases": { 
      "value": "2012-11-21", 
      "dateFormat": "YYYY-MM-DD" 
    }, 
    "EndOfSecurityVulSupportDate": { 
      "value": "2012-12-15", 
      "dateFormat": "YYYY-MM-DD" 
    }, 
    "EndOfRoutineFailureAnalysisDate": { 
      "value": " ", 
      "dateFormat": "YYYY-MM-DD" 
    }, 
    "EndOfServiceContractRenewal": { 
      "value": "2014-02-17", 
      "dateFormat": "YYYY-MM-DD" 
    }, 
    "LastDateOfSupport": { 
      "value": "2014-11-30", 
      "dateFormat": "YYYY-MM-DD" 
    }, 
    "EndOfSvcAttachDate": { 
      "value": "2012-11-21", 
      "dateFormat": "YYYY-MM-DD" 
    }, 
    "UpdatedTimeStamp": { 
      "value": "2012-01-03", 
      "dateFormat": "YYYY-MM-DD" 
    }, 
    "EOXMigrationDetails": { 
      "PIDActiveFlag": "Y ", 
      "MigrationInformation": " ", 
      "MigrationOption": "See Migration Section", 
      "MigrationProductId": " ", 
      "MigrationProductName": " ", 
      "MigrationStrategy": "...", 
      "MigrationProductInfoURL": "https://www.cisco.com" 
    }, 
    "EOXInputType": "showEoXByDates", 
    "EOXInputValue": "2011-01-01 , 2015-12-31" 
  }, 
  <!-- Output suppressed. --> 
]}

Get EoX by Product ID(s)

Returns one or more EOX records for the product or products with the specified product ID (PID) or product IDs.

URI

https://apix.cisco.com/supporttools/eox/rest/5/EOXByProductID/{pageIndex}/{productID}

Request Parameters

Parameter	Required	Type	Length	Description
pageIndex	No	integer	5	Index number of the page to return; a maximum of 50 records per page are returned.
productID	Yes	string	250	Product IDs for the products to retrieve from the database. Enter up to 20 PIDs separated by commas. For example: 15216-OADM1-35=,M92S1K9-1.3.3C Note: To enhance search capabilities, the Cisco Support Tools allows wildcards with the productIDs parameter. A minimum of 3 characters is required. For example, only the following inputs are valid: VPN, VPN, VPN, and VPN. Using wildcards can result in multiple PIDs in the output.
responseencoding	No	string	4	Format in which you want the results to appear. Valid values are: xml and json.

Response Parameters

Parameter	Description
PaginationResponseRecord	Index number for the page requested and the total number of pages available to return. See PaginationResponseRecordType for more information.
EOXRecord	EoX information for the requested products. You can receive multiple EoX records for the same PID if that product includes multiple migration paths; see EOXRecordType for more information.

Sample XML Request

GET https://apix.cisco.com/supporttools/eox/rest/5/EOXByProductID/1/WIC-1T=?responseencoding=xml

Sample XML Response

<eox:ShowEOXByProductIDResponse xmlns:eox="https://www.cisco.com/services/ssapi/eox/1">  
   <eox:PaginationResponseRecord>  
      <eox:PageIndex>1</eox:PageIndex>  
      <eox:LastIndex>1</eox:LastIndex>  
      <eox:TotalRecords>1</eox:TotalRecords>  
      <eox:PageRecords>1</eox:PageRecords>  
   </eox:PaginationResponseRecord>  
   <eox:EOXRecord>  
      <eox:EOLProductID>WIC-1T=</eox:EOLProductID>  
      <eox:ProductIDDescription>WAN Interface Card</eox:ProductIDDescription>  
      <eox:ProductBulletinNumber>EOL6640</eox:ProductBulletinNumber>  
      <eox:LinkToProductBulletinURL>...</eox:LinkToProductBulletinURL>  
      <eox:EOXExternalAnnouncementDate dateFormat="YYYY-MM-DD">2008-12-28</eox:EOXExternalAnnouncementDate>  
      <eox:EndOfSaleDate dateFormat="YYYY-MM-DD">2009-12-28</eox:EndOfSaleDate>  
      <eox:EndOfSWMaintenanceReleases dateFormat="YYYY-MM-DD">2010-12-28</eox:EndOfSWMaintenanceReleases>  
      <eox:EndOfSecurityVulSupportDate dateFormat="YYYY-MM-DD">2012-12-15</eox:EndOfSecurityVulSupportDate>  
      <eox:EndOfRoutineFailureAnalysisDate dateFormat="YYYY-MM-DD">2010-12-28</eox:EndOfRoutineFailureAnalysisDate>  
      <eox:EndOfServiceContractRenewal dateFormat="YYYY-MM-DD">2014-03-28</eox:EndOfServiceContractRenewal>  
      <eox:LastDateOfSupport dateFormat="YYYY-MM-DD">2014-12-27</eox:LastDateOfSupport>  
      <eox:EndOfSvcAttachDate dateFormat="YYYY-MM-DD">2010-12-28</eox:EndOfSvcAttachDate>  
      <eox:UpdatedTimeStamp dateFormat="YYYY-MM-DD"> 2009-08-25</eox:UpdatedTimeStamp>  
      <eox:EOXMigrationDetails>  
         <eox:PIDActiveFlag>Y</eox:PIDActiveFlag>  
         <eox:MigrationInformation>WAN Interface Card</eox:MigrationInformation>  
         <eox:MigrationOption>Enter PID(s)</eox:MigrationOption>  
         <eox:MigrationProductId>HWIC-1T=</eox:MigrationProductId>  
         <eox:MigrationProductName></eox:MigrationProductName>  
         <eox:MigrationStrategy></eox:MigrationStrategy>  
         <eox:MigrationProductInfoURL>...</eox:MigrationProductInfoURL>  
      </eox:EOXMigrationDetails>  
      <eox:EOXInputType>ShowEOXByPids</eox:EOXInputType>  
      <eox:EOXInputValue>WIC-1T=</eox:EOXInputValue>  
   </eox:EOXRecord>  
</eox:ShowEOXByProductIDResponse>

Sample JSON Request

GET https://apix.cisco.com/supporttools/eox/rest/5/EOXByProductID/1/WIC-1T=?responseencoding=json

Sample JSON Response

{
	"PaginationResponseRecord": {
		"PageIndex": 1,
		"LastIndex": 1,
		"TotalRecords": 1,
		"PageRecords": 1
	},
	"EOXRecord": [{
		"EOLProductID": "WIC-1T=",
		"ProductIDDescription": "WAN Interface Card",
		"ProductBulletinNumber": "EOL6640",
		"LinkToProductBulletinURL": "https://www.cisco.com",  
		"EOXExternalAnnouncementDate": {
			"value": "2008-12-28",
			"dateFormat": "YYYY-MM-DD"
		},
		"EndOfSaleDate": {
			"value": "2009-12-28",
			"dateFormat": "YYYY-MM-DD"
		},
		"EndOfSWMaintenanceReleases": {
			"value": "2010-12-28",
			"dateFormat": "YYYY-MM-DD"
		},
		"EndOfSecurityVulSupportDate": {
			"value": "2012-12-15",
			"dateFormat": "YYYY-MM-DD"
		},
		"EndOfRoutineFailureAnalysisDate": {
			"value": "2010-12-28",
			"dateFormat": "YYYY-MM-DD"
		},
		"EndOfServiceContractRenewal": {
			"value": "2014-03-28",
			"dateFormat": "YYYY-MM-DD"
		},
		"LastDateOfSupport": {
			"value": "2014-12-27",
			"dateFormat": "YYYY-MM-DD"
		},
		"EndOfSvcAttachDate": {
			"value": "2010-12-28",
			"dateFormat": "YYYY-MM-DD"
		},
		"UpdatedTimeStamp": {
			"value": "2009-08-25",
			"dateFormat": "YYYY-MM-DD"
		},
		"EOXMigrationDetails": {
			"PIDActiveFlag": "Y ",
			"MigrationInformation": "WAN Interface Card",
			"MigrationOption": "Enter PID(s)",
			"MigrationProductId": "HWIC-1T=",
			"MigrationProductName": " ",
			"MigrationStrategy": " ",
			"MigrationProductInfoURL": "https://www.cisco.com"  
		},
		"EOXInputType": "ShowEOXByPids",
		"EOXInputValue": "WIC-1T= "
	}]
}

Get EoX By Serial Number(s)

Returns the EoX record for products with the specified serial numbers.

URI

https://apix.cisco.com/supporttools/eox/rest/5/EOXBySerialNumber/{pageIndex}/{serialNumber}

Request Parameters

Parameter	Required	Type	Length	Description
pageIndex	No	integer	5	Index number of the page to return; a maximum of 50 records per page are returned.
serialNumber	Yes	string	40	Device serial number or numbers for which to return results. You can enter up to 20 serial numbers (each with a maximum length of 40) separated by commas.
responseencoding	No	string	4	Format in which you would like the results to appear. Valid values are: xml and json.

Response Parameters

Parameter	Description
PaginationResponseRecord	Index number for the page requested and the total number of pages available to return. See PaginationResponseRecordType for more information.
EOXRecord	EoX information for the requested products. You can receive multiple EoX records for the same PID if that product includes multiple migration paths; see EOXRecordType for more information.

Sample XML Request

GET https://apix.cisco.com/supporttools/eox/rest/5/EOXBySerialNumber/1/FHK0933224R?responseencoding=xml

Sample XML Response

<eox:ShowEOXBySerialNumberResponse xmlns:eox="https://www.cisco.com/services/ssapi/eox/1">  
   <eox:PaginationResponseRecord>  
      <eox:PageIndex>1</eox:PageIndex>  
      <eox:LastIndex>1</eox:LastIndex>  
      <eox:TotalRecords>1</eox:TotalRecords>  
      <eox:PageRecords>1</eox:PageRecords>  
   </eox:PaginationResponseRecord>  
   <eox:EOXRecord>  
      <eox:EOLProductID>CISCO1811/K9</eox:EOLProductID>  
      <eox:ProductIDDescription>Security Router</eox:ProductIDDescription>  
      <eox:ProductBulletinNumber>EOL7073</eox:ProductBulletinNumber>  
      <eox:LinkToProductBulletinURL>...</eox:LinkToProductBulletinURL>  
      <eox:EOXExternalAnnouncementDate dateFormat="YYYY-MM-DD">2010-04-16</eox:EOXExternalAnnouncementDate>  
      <eox:EndOfSaleDate dateFormat="YYYY-MM-DD">2011-04-16</eox:EndOfSaleDate>  
      <eox:EndOfSWMaintenanceReleases dateFormat="YYYY-MM-DD">2012-04-15</eox:EndOfSWMaintenanceReleases>  
      <eox:EndOfSecurityVulSupportDate dateFormat="YYYY-MM-DD">2012-12-15</eox:EndOfSecurityVulSupportDate>  
      <eox:EndOfRoutineFailureAnalysisDate dateFormat="YYYY-MM-DD">2012-04-15</eox:EndOfRoutineFailureAnalysisDate>  
      <eox:EndOfServiceContractRenewal dateFormat="YYYY-MM-DD">2015-07-15</eox:EndOfServiceContractRenewal>  
      <eox:LastDateOfSupport dateFormat="YYYY-MM-DD">2016-04-30</eox:LastDateOfSupport>  
      <eox:EndOfSvcAttachDate dateFormat="YYYY-MM-DD">2012-04-15</eox:EndOfSvcAttachDate>  
      <eox:UpdatedTimeStamp dateFormat="YYYY-MM-DD">2010-04-18</eox:UpdatedTimeStamp>  
      <eox:EOXMigrationDetails>  
            <eox:PIDActiveFlag>Y</eox:PIDActiveFlag>  
            <eox:MigrationInformation>SecRouter</eox:MigrationInformation>  
            <eox:MigrationOption>Enter PID(s)</eox:MigrationOption>  
            <eox:MigrationProductId>CISCO891-K9</eox:MigrationProductId>  
            <eox:MigrationProductName></eox:MigrationProductName>  
            <eox:MigrationStrategy></eox:MigrationStrategy>  
            <eox:MigrationProductInfoURL>...</eox:MigrationProductInfoURL>  
      </eox:EOXMigrationDetails>  
      <eox:EOXInputType>ShowEOXBySerialNumber</eox:EOXInputType>  
      <eox:EOXInputValue>FHK0933224R</eox:EOXInputValue>  
   </eox:EOXRecord>  
</eox:ShowEOXBySerialNumberResponse>

Sample JSON Request

GET https://apix.cisco.com/supporttools/eox/rest/5/EOXBySerialNumber/1/FHK0933224R?responseencoding=json

Sample JSON Response

{
	"PaginationResponseRecord": {
		"PageIndex": 1,
		"LastIndex": 1,
		"TotalRecords": 1,
		"PageRecords": 1
	},
	"EOXRecord": [{
		"EOLProductID": "CISCO1811/K9",
		"ProductIDDescription": "Security Router",
		"ProductBulletinNumber": "EOL7073",
		"LinkToProductBulletinURL": "https://www.cisco.com",  
		"EOXExternalAnnouncementDate": {
			"value": "2010-04-16",
			"dateFormat": "YYYY-MM-DD"
		},
		"EndOfSaleDate": {
			"value": "2011-04-16",
			"dateFormat": "YYYY-MM-DD"
		},
		"EndOfSWMaintenanceReleases": {
			"value": "2012-04-15",
			"dateFormat": "YYYY-MM-DD"
		},
		"EndOfSecurityVulSupportDate": {
			"value": "2012-12-15",
			"dateFormat": "YYYY-MM-DD"
		},
		"EndOfRoutineFailureAnalysisDate": {
			"value": "2012-04-15",
			"dateFormat": "YYYY-MM-DD"
		},
		"EndOfServiceContractRenewal": {
			"value": "2015-07-15",
			"dateFormat": "YYYY-MM-DD"
		},
		"LastDateOfSupport": {
			"value": "2016-04-30",
			"dateFormat": "YYYY-MM-DD"
		},
		"EndOfSvcAttachDate": {
			"value": "2012-04-15",
			"dateFormat": "YYYY-MM-DD"
		},
		"UpdatedTimeStamp": {
			"value": "2010-04-18",
			"dateFormat": "YYYY-MM-DD"
		},
		"EOXMigrationDetails": {
			"PIDActiveFlag": "Y ",
			"MigrationInformation": "Cisco 891 GigaE SecRouter",
			"MigrationOption": "Enter PID(s)",
			"MigrationProductId": "CISCO891-K9",
			"MigrationProductName": " ",
			"MigrationStrategy": " ",
			"MigrationProductInfoURL": "https://www.cisco.com"  
		},
		"EOXInputType": "ShowEOXBySerialNumber",
		"EOXInputValue": "FHK0933224R"
	}]
}

Get EoX by Software Release String(s)

Returns the EoX record for products associated with the specified software release and (optionally) the specified operating system.

URI

https://apix.cisco.com/supporttools/eox/rest/5/EOXBySWReleaseString/{pageIndex}/{input1}

Request Parameters

Parameter	Required	Type	Length	Description
pageIndex	Yes	integer	5	Index number of the page to return. For example, 1 returns the first page of the total number of available pages. See PaginationRequestRecordType for more information.
input1 , input2 , ... input20	Yes	string	250	String for software release and type of operating system (optional) for the requested product. For example: 12.2,IOS You can enter up to 20 software release and operating system type combinations. Each combination can return multiple EoX records; see SWReleaseStringType for more information.
responseencoding	No	string	4	Format in which you would like the results to appear. Valid values are: xml and json.

Response Parameters

Parameter	Description
PaginationResponseRecord	Index number for the page requested and the total number of pages available to return. See PaginationResponseRecordType for more information.
EOXRecord	EoX information for the requested products. You can receive multiple EoX records for the same PID if that product includes multiple migration paths; see EOXRecordType for more information.

Sample XML Request

GET https://apix.cisco.com/supporttools/eox/rest/5/EOXBySWReleaseString/1?responseencoding=XML&input1=12.4%2815%29T,IOS

Sample XML Response

<eox:ShowEOXBySWReleaseStringResponse xmlns:eox="https://www.cisco.com/services/ssapi/eox/1">  
      <eox:PaginationResponseRecord>  
            <eox:PageIndex>1</eox:PageIndex>  
            <eox:LastIndex>1</eox:LastIndex>  
            <eox:TotalRecords>989</eox:TotalRecords>  
            <eox:PageRecords>989</eox:PageRecords>  
      </eox:PaginationResponseRecord>  
      <eox:EOXRecord>  
            <eox:EOLProductID>S280IPBK9-12424T=</eox:EOLProductID>  
            <eox:ProductIDDescription>Cisco 2801 IOS IP BASE </eox:ProductIDDescription>  
            <eox:ProductBulletinNumber>EOL7267</eox:ProductBulletinNumber>  
            <eox:LinkToProductBulletinURL>https://www.cisco.com/en/US/prod/collateral/iosswrel/ps8802/ps6968/ps6441/eol_c51-632350.html</eox:LinkToProductBulletinURL>  
            <eox:EOXExternalAnnouncementDate dateFormat="YYYY-MM-DD">2010-11-01</eox:EOXExternalAnnouncementDate>  
            <eox:EndOfSaleDate dateFormat="YYYY-MM-DD">2011-11-01</eox:EndOfSaleDate>  
            <eox:EndOfSWMaintenanceReleases dateFormat="YYYY-MM-DD">2012-10-31</eox:EndOfSWMaintenanceReleases>  
            <eox:EndOfSecurityVulSupportDate dateFormat="YYYY-MM-DD">2012-12-15</eox:EndOfSecurityVulSupportDate>  
            <eox:EndOfRoutineFailureAnalysisDate dateFormat="YYYY-MM-DD"></eox:EndOfRoutineFailureAnalysisDate>  
            <eox:EndOfServiceContractRenewal dateFormat="YYYY-MM-DD">2016-01-30</eox:EndOfServiceContractRenewal>  
            <eox:LastDateOfSupport dateFormat="YYYY-MM-DD">2016-11-30</eox:LastDateOfSupport>  
            <eox:EndOfSvcAttachDate dateFormat="YYYY-MM-DD">2012-10-31</eox:EndOfSvcAttachDate>  
            <eox:UpdatedTimeStamp dateFormat="YYYY-MM-DD">2012-06-14</eox:UpdatedTimeStamp>  
            <eox:EOXMigrationDetails>  
                  <eox:PIDActiveFlag>Y</eox:PIDActiveFlag>  
                  <eox:MigrationInformation></eox:MigrationInformation>  
                  <eox:MigrationOption>See Migration Section</eox:MigrationOption>  
                  <eox:MigrationProductId></eox:MigrationProductId>  
                  <eox:MigrationProductName></eox:MigrationProductName>  
                  <eox:MigrationStrategy>Customers are encouraged to migrate to the Cisco IOS Software Release 15.1(2)T. Information about this product can be found at: https://www.cisco.com/en/US/products/ps10952/index.html.</eox:MigrationStrategy>  
                  <eox:MigrationProductInfoURL>https://www.cisco.com/en/US/products/ ps10952/index.html</eox:MigrationProductInfoURL>  
            </eox:EOXMigrationDetails>  
            <eox:EOXInputType>ShowEOXBySoftware</eox:EOXInputType>  
      </eox:EOXRecord>  
      <eox:EOXRecord>  
            <eox:EOLProductID>S54AVSK9U-12424T</eox:EOLProductID>  
            <eox:ProductIDDescription>Cisco AS5400 Ser. IOS INT VOICE/VIDEO IPIPGW, TDMIP GW LI</eox:ProductIDDescription>  
            <eox:ProductBulletinNumber>EOL7267</eox:ProductBulletinNumber>  
            <eox:LinkToProductBulletinURL>https://www.cisco.com/en/US/prod/collateral/iosswrel/ps8802/ps6968/ps6441/eol_c51-632350.html</eox:LinkToProductBulletinURL>  
            <eox:EOXExternalAnnouncementDate dateFor-mat="YYYY-MM-DD">2010-11-01</eox:EOXExternalAnnouncementDate>  
            <eox:EndOfSaleDate dateFormat="YYYY-MM-DD">2011-11-01</eox:EndOfSaleDate>  
            <eox:EndOfSWMaintenanceReleases dateFor-mat="YYYY-MM-DD">2012-10-31</eox:EndOfSWMaintenanceReleases>  
            <eox:EndOfRoutineFailureAnalysisDate dateFor-mat="YYYY-MM-DD"></eox:EndOfRoutineFailureAnalysisDate>  
            <eox:EndOfServiceContractRenewal dateFor-mat="YYYY-MM-DD">2016-01-30</eox:EndOfServiceContractRenewal>  
            <eox:LastDateOfSupport dateFormat="YYYY-MM-DD">2016-11-30</eox:LastDateOfSupport>  
            <eox:EndOfSvcAttachDate dateFormat="YYYY-MM-DD">2012-10-31</eox:EndOfSvcAttachDate>  
            <eox:UpdatedTimeStamp dateFormat="YYYY-MM-DD">2012-06-14</eox:UpdatedTimeStamp>  
            <eox:EOXMigrationDetails>  
                  <eox:PIDActiveFlag>Y</eox:PIDActiveFlag>  
                  <eox:MigrationInformation></eox:MigrationInformation>  
                  <eox:MigrationOption>See Migration Section</eox:MigrationOption>  
                  <eox:MigrationProductId></eox:MigrationProductId>  
                  <eox:MigrationProductName></eox:MigrationProductName>  
                  <eox:MigrationStrategy>Customers are encouraged to migrate to the Cisco IOS Software Release 15.1(2)T. Information about this product can be found at: https://www.cisco.com/en/US/products/ps10952/index.html.</eox:MigrationStrategy>  
                  <eox:MigrationProductInfoURL>https://www.cisco.com/en/US/products/ps10952/index.html</eox:MigrationProductInfoURL>  
            </eox:EOXMigrationDetails>  
            <eox:EOXInputType>ShowEOXBySoftware</eox:EOXInputType>  
            <eox:EOXInputValue>input1=12.4%2815%29T,IOS</eox:EOXInputValue>  
      </eox:EOXRecord>  
      <!-- Output suppressed. -->  
</eox:ShowEOXBySWReleaseStringResponse>

Sample JSON Request

GET https://apix.cisco.com/supporttools/eox/rest/5/EOXBySWReleaseString/1?responseencoding=json&input1=12.4%2815%29T,IOS

Sample JSON Response

{
	"PaginationResponseRecord": {
		"PageIndex": 1,
		"LastIndex": 1,
		"TotalRecords": 989,
		"PageRecords": 989
	},
	"EOXRecord": [{
		"EOLProductID": "S280IPBK9-12424T=",
		"ProductIDDescription": "Cisco 2801 IOS IP BASE",
		"ProductBulletinNumber": "EOL7267",
		"LinkToProductBullet-let-inURL":"https://www.cisco.com/en/US/prod/collateral/iosswrel/ps8802/ps6968/ps6441/eol_c51-632350.html",  
		"EOXExternalAnnouncementDate": {
			"value": "2010-11-01",
			"dateFormat": "YYYY-MM-DD"
		},
		"EndOfSaleDate": {
			"value": "2011-11-01",
			"dateFormat": "YYYY-MM-DD"
		},
		"EndOfSWMaintenanceReleases": {
			"value": "2012-10-31",
			"dateFormat": "YYYY-MM-DD"
		},
		"EndOfSecurityVulSupportDate": {
			"value": "2012-12-15",
			"dateFormat": "YYYY-MM-DD"
		},
		"EndOfRoutineFailureAnalysisDate": {
			"value": " ",
			"dateFormat": "YYYY-MM-DD"
		},
		"EndOfServiceContractRenewal": {
			"value": "2016-01-30",
			"dateFormat": "YYYY-MM-DD"
		},
		"LastDateOfSupport": {
			"value": "2016-11-30",
			"dateFormat": "YYYY-MM-DD"
		},
		"EndOfSvcAttachDate": {
			"value": "2012-10-31",
			"dateFormat": "YYYY-MM-DD"
		},
		"UpdatedTimeStamp": {
			"value": "2012-06-14",
			"dateFormat": "YYYY-MM-DD"
		},
		"EOXMigrationDetails": {
			"PIDActiveFlag": "Y ",
			"MigrationInformation": " ",
			"MigrationOption": "See Migration Section",
			"MigrationProductId": " ",
			"MigrationProductName": " ",
			"MigrationStrategy": "Customers are encouraged to migrate to the
			Cisco IOS Software Release 15.1(2)T. Information about this
			product can be found at: https://www.cisco.com/en/US/  
			products/ps10952/index.html.",
			"MigrationProductInfoURL": "https://www.cisco.com/en/US/products/ps10952/index.html"  
		},
			"EOXInputType": "ShowEOXBySoftware"
			"EOXInputValue": "input1=12.4%2815%29T,IOS"
		},
		<!-- Output suppressed. -->
	}]
}

Request and Response Parameters

Request Parameters

This topic describes the following Cisco EoX APIrequest and response parameters:

PaginationRequestRecordType
SWReleaseStringType

PaginationRequestRecordType

Specifies the page to return when multiple pages are available. This request parameter is optional for all methods.

Request Parameter(s)

Parameter	Required	Type	Length	Description
PageIndex	No	integer	5	Index number of the page to return. For example, 1 returns the first page of the total number of available pages. To retrieve the total number of pages, call the method using the page number you want to return. For example, if the LastIndex PaginationResponseRecord parameter is 14, call the method 14 times and increment the PageIndex value each time. See PaginationResponseRecordType for more information on the LastIndex parameter.

Sample Request

GET https://apix.cisco.com/supporttools/eox/rest/5/EOXByProductID/1/WIC-1T=?responseencoding=json

SWReleaseStringType

Specifies the software release string and the type of operating system for the requested products. This request parameter is used with the Get EoX by Software Release String(s) method. SWReleaseStringType normally returns a set of software PIDs.

Parameters

Parameter	Required	Type	Length	Description
SWReleaseString	Yes	string	200	Software release string or strings for the requested product. For example: 9.21(7) You can enter up to 20 software release strings by repeating the SWReleaseStringRecord.
OSType	No	string	20	Operating system for the requested product. OSType can be one of the following values: ACNS ACSW ALTIGAOS ASA ASYNCOS CATOS CDS-IS CDS-TV CDS-VN CDS-VQE CTS ECDS FWSM-OS GSS IOS IOS XR IOS-XE IPS NAM NX-OS ONS PIXOS SAN-OS STAR OS TC TE UCS NX-OS VCS VDS-IS WAAS WANSW BPX/IGX/IPX WEBNS WLC WLSE-OS XC

Note: SWReleaseString and OSType are entered as one parameter; see the sample request below for an example.

Sample Request

GET https://apix.cisco.com/supporttools/eox/rest/5/EOXBySWReleaseString/1/?input1=12.4(15),IOS&responseencoding=json

Response Parameters

This topic describes the following Cisco Support Tools response parameters:

EOXErrorType
EOXMigrationDetailsType
EOXRecordType
PaginationResponseRecordType

EOXErrorType

Provides information about errors that occur during an operation. For more information on error codes, see Error Codes.

Parameters

Parameter	Type	Length	Description
ErrorID	string	20	Identification number associated with the error message.
ErrorDescription	string	100	Description of the error message.
ErrorDataType	string	20	Describes the type of error returned. This element is returned only if the requested serial number or software string can be mapped to a product ID or product bulletin, and the product ID or product bulletin does not correspond to end-of-life data. Possible values include: PRODUCT_ID PRODUCT_BULLETIN
ErrorDataValue	string	20	Describes the mapped product ID or product bulletin identified by the ErrorDataType. This element is returned only with the ErrorDataType parameter.

Note: The ErrorDataType and ErrorDataValue parameters are returned for the following methods only: Get EoX By Serial Number(s) and Get EoX by Software Release String(s).

Sample XML Response

<EOXError>
	<ErrorID>SSA_ERR_026</ErrorID>
	<ErrorDataType>PRODUCT_ID</ErrorDataType>
   <ErrorDataValue>ILPM-8=</ErrorDataValue>
   <ErrorDescription>EOX information does not exist for the following product ID(s): ILPM-8=</ErrorDescription>
</EOXError>

Sample JSON Response

"EOXError": {
   "ErrorID": "SSA_ERR_026",
   "ErrorDescription": "EOX information does not exist for the following product ID(s): ILPM-8=",
   "ErrorDataType": "PRODUCT_ID",
   "ErrorDataValue": "ILPM-8="
}

EOXMigrationDetailsType

Provides information about migration details for the requested product. This response parameter is returned with the EOXRecordType response type.

Parameters

Parameter	Type	Length	Description
PIDActiveFlag	string	1	Indicates whether the requested product has been migrated.
MigrationInformation	string	500	Provides a description of the replacement product.
MigrationOption	string	24	Indicates whether a replacement is available.
MigrationProductId	string	48	Provides the identifier for the replacement product.
MigrationProductName	string	200	Provides the name of the replacement product.
MigrationStrategy	string	1334	Describes the strategy the user should take in migrating to the next migration product and/or software.
MigrationProductInfoURL	string	500	Provides the URL to information about the migrated product.

Sample XML Response

<eox:EOXMigrationDetails>
   <eox:PIDActiveFlag>Y</eox:PIDActiveFlag>
   <eox:MigrationInformation>WAN Interface Card</eox:MigrationInformation>
   <eox:MigrationOption>Enter PID(s)</eox:MigrationOption>
   <eox:MigrationProductId>HWIC-1T=</eox:MigrationProductId>
   <eox:MigrationProductName></eox:MigrationProductName>
   <eox:MigrationStrategy></eox:MigrationStrategy>
   <eox:MigrationProductInfoURL>...</eox:MigrationProductInfoURL>
</eox:EOXMigrationDetails>

Sample JSON Response

"EOXMigrationDetails": {
   "PIDActiveFlag": "Y  ",
   "MigrationInformation": "WAN Interface Card",
   "MigrationOption": "Enter PID(s)",
   "MigrationProductId": "HWIC-1T=",
   "MigrationProductName": " ",
   "MigrationStrategy": " ",
   "MigrationProductInfoURL": "https://www.cisco.com"
}

EOXRecordType

Provides detailed EoX information for the requested product.

Note: Normally, each unique fully qualified PID returns one EoX record. However, if the associated product includes more than one migration path, multiple EoX records are returned. The EOXMigrationDetails information for these records differ; all other information, including the UpdatedTimeStamp value, is identical.

Parameters

Parameter	Type	Length	Description
EOLProductID	string	48	Product ID assigned to the product.
ProductIDDescription	string	500	Description of the product.
ProductBulletinNumber	string	24	Number assigned to the EoX product bulletin that announces the end of sale and end of life of the product to the general public.
LinkToProductBulletinURL	string	500	URL to the EoX product bulletin associated with the product.
EOXExternalAnnouncementDate	string	DATE	Date that the end of sale and end of life of the product was announced to the general public.
EndOfSaleDate	string	DATE	Last date to order the requested product through Cisco point-of-sale mechanisms. The product is no longer for sale after this date.
EndOfSWMaintenanceReleases	string	DATE	Last date that Cisco Engineering might release any software maintenance releases or bug fixes to the software product. After this date, Cisco Engineering no longer develops, repairs, maintains, or tests the product software.
EndOfSecurityVulSupportDate	string	DATE	Last date that Cisco Engineering may release a planned maintenance release or scheduled software remedy for a security vulnerability issue.
EndOfRoutineFailureAnalysisDate	string	DATE	Last date Cisco might perform a routine failure analysis to determine the root cause of an engineering-related or manufacturing-related issue.
EndOfServiceContractRenewal	string	DATE	Last date to extend or renew a service contract for the product. The extension or renewal period cannot extend beyond the last date of support.
LastDateOfSupport	string	DATE	Last date to receive service and support for the product. After this date, all support services for the product are unavailable, and the product becomes obsolete.
EndOfSvcAttachDate	string	DATE	Last date to order a new service-and-support contract or add the equipment and/or software to an existing service-and-support contract for equipment and software that is not covered by a service-and-support contract.
UpdatedTimeStamp	string	DATE	Date the EoX record was created or last modified.
EOXError	EOXErrorType	See EOXErrorType	Information that describes an error (if any) received during the operation. See EOXErrorType for more information.
EOXMigrationDetails	EOXMigrationDetailsType	See EOXMigrationDetailsType	Information regarding migration of the EoX product. See EOXMigrationDetailsType for more information.
EOXInputType	string	N/A	Method name of the request sent for this operation.
EOXInputValue	string	N/A	Request parameters sent for this operation.

Sample XML Response

<eox:EOXRecord>
   <eox:EOLProductID>WIC-1T=</eox:EOLProductID>
   <eox:ProductIDDescription>WAN Interface Card</eox:ProductIDDescription>
   <eox:ProductBulletinNumber>EOL6640</eox:ProductBulletinNumber>
   <eox:LinkToProductBulletinURL>...</eox:LinkToProductBulletinURL>
   <eox:EOXExternalAnnouncementDate dateFormat="YYYY-MM-DD">2008-12-28</eox:EOXExternalAnnouncementDate>
   <eox:EndOfSaleDate dateFormat="YYYY-MM-DD">2009-12-28</eox:EndOfSaleDate>
   <eox:EndOfSWMaintenanceReleases dateFormat="YYYY-MM-DD">2010-12-28</eox:EndOfSWMaintenanceReleases>
   <eox:EndOfSecurityVulSupportDateFormat="YYYY-MM-DD">2010-12-28</eox:EndOfSWMaintenanceReleases>  
   <eox:EndOfRoutineFailureAnalysisDate dateFormat="YYYY-MM-DD">2010-12-28</eox:EndOfRoutineFailureAnalysisDate>
   <eox:EndOfServiceContractRenewal dateFormat="YYYY-MM-DD">2014-03-28</eox:EndOfServiceContractRenewal>
   <eox:LastDateOfSupport dateFormat="YYYY-MM-DD">2014-12-27</eox:LastDateOfSupport>
   <eox:EndOfSvcAttachDate dateFormat="YYYY-MM-DD">2010-12-28</eox:EndOfSvcAttachDate>
   <eox:UpdatedTimeStamp dateFormat="YYYY-MM-DD">2009-08-25</eox:UpdatedTimeStamp>
   <eox:EOXMigrationDetails>
      <eox:PIDActiveFlag>Y</eox:PIDActiveFlag>
      <eox:MigrationInformation>WAN Interface Card</eox:MigrationInformation>
      <eox:MigrationOption>Enter PID(s)</eox:MigrationOption>
      <eox:MigrationProductId>HWIC-1T=</eox:MigrationProductId>
      <eox:MigrationProductName></eox:MigrationProductName>
      <eox:MigrationStrategy></eox:MigrationStrategy>
      <eox:MigrationProductInfoURL>...</eox:MigrationProductInfoURL>
   </eox:EOXMigrationDetails>
   <eox:EOXInputType>ShowEOXByPids</eox:EOXInputType>
   <eox:EOXInputValue>WIC-1T=</eox:EOXInputValue>
</eox:EOXRecord>

Sample JSON Response

"EOXRecord": { 
   "EOLProductID": "WIC-1T=", 
   "ProductIDDescription": "1-Port Serial WAN Interface Card", 
   "ProductBulletinNumber": "EOL6640", 
   "LinkToProductBulletinURL": "https://www.cisco.com", 
   "EOXExternalAnnouncementDate": { 
      "value": "2008-12-28", 
      "dateFormat": "YYYY-MM-DD" 
   }, 
   "EndOfSaleDate": { 
      "value": "2009-12-28", 
      "dateFormat": "YYYY-MM-DD" 
   }, 
   "EndOfSWMaintenanceReleases": { 
      "value": "2010-12-28", 
      "dateFormat": "YYYY-MM-DD" 
   }, 
   "EndOfSecurityVulSupportDate": { 
      "value": "2010-12-28", 
      "dateFormat": "YYYY-MM-DD" 
   }, 
   "EndOfRoutineFailureAnalysisDate": { 
      "value": "2010-12-28", 
      "dateFormat": "YYYY-MM-DD" 
   }, 
   "EndOfServiceContractRenewal": { 
      "value": "2014-03-28", 
      "dateFormat": "YYYY-MM-DD" 
   }, 
   "LastDateOfSupport": { 
      "value": "2014-12-27", 
      "dateFormat": "YYYY-MM-DD" 
   }, 
   "EndOfSvcAttachDate": { 
      "value": "2010-12-28", 
      "dateFormat": "YYYY-MM-DD" 
   }, 
   "UpdatedTimeStamp": { 
      "value": "2009-08-25", 
      "dateFormat": "YYYY-MM-DD" 
   }, 
   "EOXMigrationDetails": { 
      "PIDActiveFlag": "Y  ", 
      "MigrationInformation": "1-Port Serial WAN Interface Card", 
      "MigrationOption": "Enter PID(s)", 
      "MigrationProductId": "HWIC-1T=", 
      "MigrationProductName": " ", 
      "MigrationStrategy": " ", 
      "MigrationProductInfoURL": "https://www.cisco.com" 
   }, 
   "EOXInputType": "ShowEOXByPids", 
   "EOXInputValue": "WIC-1T= " 
}

PaginationResponseRecordType

Provides information about the page requested and the total number of pages available to return.

Parameters

Parameter	Type	Length	Description
PageIndex	integer	5	Index number of the requested page.
LastIndex	integer	5	Total number of pages available.
TotalRecords	integer	5	Total results for this query.
PageRecords	integer	5	Total results for this page.

Sample XML Response

<eox:PaginationResponseRecord>
    <eox:PageIndex>1</eox:PageIndex>
    <eox:LastIndex>89</eox:LastIndex>
    <eox:TotalRecords>88188</eox:TotalRecords>
    <eox:PageRecords>1000</eox:PageRecords>
</eox:PaginationResponseRecord>

Sample JSON Response

"PaginationResponseRecord": {
   "PageIndex": 1,
   "LastIndex": 89,
   "TotalRecords": 88188,
   "PageRecords": 1000
}

Error Codes

This table describes the error codes returned by the EOX Service API methods.

Error Code	Message
SSA_GENERIC_ERR	General error.
SSA_ERR_001	The startDate value specified is invalid or formatted incorrectly. Please correct the startDate value and try again.
SSA_ERR_003	The number of SWReleaseString exceeds 20.
SSA_ERR_007	The number of serial numbers exceeds 20.
SSA_ERR_009	The number of product IDs exceeds 20.
SSA_ERR_010	The responseencoding value is invalid. Please correct the responseencoding value and try again. Valid responseencoding values are json and xml. OR The pageIndex value specified is invalid. Please correct the pageIndex value and try again. OR The startDate and/or endDate value specified is invalid or formatted incorrectly. Please correct the startDate and/or endDate value and try again. OR The eoxAttrib value is invalid. Please correct the eoxAttrib value and try again. OR The productIDs value(s) contain invalid characters. Please correct the productIDs value(s) and try again. OR The serialNumbers value specified is invalid. Please correct the serialNumbers value and try again. OR The OSType value is invalid. Please correct the OSType value and try again.
SSA_ERR_011	The EoX database is currently unavailable. Please try again later or send an email to ssapi-pilot-help@cisco.com.
SSA_ERR_012	The EoX database is currently unavailable. Please try again later or send an email to ssapi-pilot-help@cisco.com.
SSA_ERR_013	There is a problem with this service. Please try again later or send an email to ssapi-pilot-help@cisco.com.
SSA_ERR_014	The EoX database is currently unavailable. Please try again later or send an email to ssapi-pilot-help@cisco.com.
SSA_ERR_015	No product IDs were found.
SSA_ERR_016	The startDate value is empty. Please enter the startDate value and try again. OR The endDate value is empty. Please enter the endDate value and try again. OR The productIDs value is empty. Please enter the productIDs value and try again. OR The serialNumbers value is empty. Please enter the serialNumbers value and try again. OR The SWReleaseString value is empty. Please enter the SWReleaseString value and try again.
SSA_ERR_018	The serial number to product ID translation service is currently down. Please try again later or send an email to ssapi-pilot-help@cisco.com.
SSA_ERR_022	EoX information does not exist for the following product bulletin(s): ...
SSA_ERR_023	EoX information does not exist for the following serial number(s): ...
SSA_ERR_024	EoX information does not exist for the following software string(s): ...
SSA_ERR_026	EoX information does not exist for the following product ID(s): ...
SSA_ERR_028	The pageIndex value specified has exceeded the limit of 5 characters. Please correct the pageIndex value and try again.
SSA_ERR_030	No product bulletins were found.
SSA_ERR_031	The request parameter is not UTF-8 compliant.
SSA_ERR_032	The productIDs wildcard search must contain a minimum of 3 characters. Please correct the productIDs wildcard search value and try again.
SSA_ERR_033	The AAA service is unavailable. Please try again later or send an email to ssapi-pilot-help@cisco.com.
SSA_ERR_034	Access denied. You are not authenticated to the End-of-Life web service.
SSA_ERR_036	Access denied. You are not authorized to access the End-of-Life web service.
SSA_ERR_037	The CEPM service is unavailable. Please try again later or send an email to ssapi-pilot-help@external.cisco.com.