List Hardware EOL - CX Cloud API

{"type":"api","title":"List Hardware EOL","meta":{"id":"/apps/pubhub/media/cx-cloud-apis/987ccbfd309f978191d5f9ff79fe93a2865583d0/cbe9e4eb-3b67-3d77-bde8-9a8275c07620","info":{"title":"CX Cloud API","version":"2.0.0","description":"APIs to access CX Cloud data","contact":{"name":"CX Cloud Community","url":"https://community.cisco.com/t5/cx-cloud/bd-p/CX-Cloud-Discussions"},"license":{"name":"Cisco API License","url":"https://developer.cisco.com/site/license/cisco-api-license/"},"termsOfService":"https://www.cisco.com/c/dam/en_us/about/doing_business/legal/seula/cx-cloud-seula.pdf"},"security":[{"Oauth2":["apis:read"]}],"tags":[{"name":"customer","description":"API operations to get customer details from entitled CX Cloud accounts"},{"name":"inventory","description":"API operations to get inventory details from entitled CX Cloud accounts"},{"name":"contract","description":"API operations to get contract details from entitled CX Cloud accounts"},{"name":"productAlert","description":"API operations to get alerts details from entitled CX Cloud accounts"}],"x-parser-conf":{"overview":{"markdownPath":"reference/overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://apix.cisco.com/cs/api/v2","description":"Cisco API Console"}],"securitySchemes":{"Oauth2":{"type":"oauth2","description":"OAuth2 authentication with authorization code flow.","flows":{"authorizationCode":{"authorizationUrl":"https://id.cisco.com/oauth2/default/v1/token","tokenUrl":"https://id.cisco.com/oauth2/default/v1/token","scopes":{"apis:read":"Grants read access"}}}}}},"spec":{"summary":"List Hardware EOL","operationId":"getHardwareEOL","description":"Returns the Hardware End of Life details of hardware assets in a CX Cloud account.","tags":["productAlert"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A CX Cloud customer identifier","schema":{"type":"string","example":"abc123def"},"$$ref":"#/components/parameters/customerId_param"},{"name":"neInstanceId","in":"query","description":"Identifier for a network element. A network element is a manageable logical entity uniting one or more physical devices and allows distributed devices to be managed in a unified way using one management system.","schema":{"type":"string","example":"NA,SERIAL,PID,NA"},"$$ref":"#/components/parameters/neInstanceId_param"},{"name":"managedNeInstanceId","in":"query","description":"Identifier for the managed network element. For single chassis devices, the managedNeInstanceId and neInstanceId are same. For multi-chassis devices, the managedNeInstanceId is the neInstanceId of the primary chassis and all the neInstanceIds will be share the same managedNeInstanceId.","schema":{"type":"string","example":"NA,SERIAL,PID,NA"},"$$ref":"#/components/parameters/managedNeInstanceId_param"},{"name":"hwInstanceId","in":"query","description":"Unique identifier of the physical hardware","schema":{"type":"string","example":"SERIAL1,PID1,NA,NA,SERIAL2,PID2,NA"},"$$ref":"#/components/parameters/hwInstanceId_param"},{"name":"hostname","in":"query","description":"Human-readable name that corresponds to the address of a device connected to a network","schema":{"type":"string","example":"switch5"},"$$ref":"#/components/parameters/hostname_param"},{"name":"hwType","in":"query","description":"Physical type of the hardware","schema":{"type":"string","example":"Chassis","enum":["Chassis","Module","Power Supply","Fan","Software"]},"$$ref":"#/components/parameters/hwType_param"},{"name":"currentHwEolMilestone","in":"query","description":"Latest hardware end-of-life milestone that has passed for the product","schema":{"type":"string","example":"LAST_SUPPORT_DATE"},"$$ref":"#/components/parameters/currentHwEolMilestone_param"},{"name":"nextHwEolMilestone","in":"query","description":"Next hardware end-of-life milestone that is coming up. If the device is already LDoS, it will not have a next milestone.","schema":{"type":"string","example":"END_OF_SALE"},"$$ref":"#/components/parameters/nextHwEolMilestone_param"},{"name":"format","in":"query","description":"Output format of the API response","schema":{"type":"string","default":"JSON","enum":["JSON","CSV","TSV"]},"$$ref":"#/components/parameters/format_param"},{"name":"fields","in":"query","description":"Restricts API response to the specific fields.","schema":{"type":"string","example":"field1,field2"},"$$ref":"#/components/parameters/fields_param"},{"name":"page","in":"query","description":"The page to return in a paginated API response.","schema":{"type":"integer","minimum":1,"default":1},"$$ref":"#/components/parameters/page_param"},{"name":"rows","in":"query","description":"The size of the page in the API response.","schema":{"type":"integer","default":20},"$$ref":"#/components/parameters/rows_param"},{"name":"sort","in":"query","description":"The sort order (ASC or DESC) for a field in the API response. Can be specified multiple times for multi-field sorting. If order is not specified for a field, it defaults to ASC. Example with multi-field sorting: sort=field&sort=field2:DESC","schema":{"type":"array","items":{"type":"string"}},"explode":true,"$$ref":"#/components/parameters/sort_param"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"Hardware EOL schema","type":"object","properties":{"data":{"description":"Contains array of Hardware EOL","type":"array","items":{"properties":{"hwInstanceId":{"description":"Unique identifier of the physical hardware","type":"string","example":"SERIAL1,PID1,NA,NA,SERIAL2,PID2,NA"},"neInstanceId":{"description":"Identifier for a network element. A network element is a manageable logical entity uniting one or more physical devices and allows distributed devices to be managed in a unified way using one management system.","type":"string","example":"NA,SERIAL,PID,NA"},"customerId":{"description":"A CX Cloud customer identifier.","type":"string","example":"abc123def"},"managedNeInstanceId":{"description":"Identifier for the managed network element. For single chassis devices, the managedNeInstanceId and neInstanceId are the same. For multi-chassis devices, the managedNeInstanceId is the neInstanceId of the primary chassis and all the neInstanceIds share the same managedNeInstanceId.","type":"string","example":"NA,SERIAL,PID,NA"},"hwType":{"description":"Physical type of the hardware","type":"string","nullable":true,"example":"Chassis","enum":["Chassis","Module","Power Supply","Fan","Software"]},"currentHwEolMilestone":{"description":"Latest hardware end-of-life milestone that has passed for the product","type":"string","nullable":true,"example":"LAST_SUPPORT_DATE"},"nextHwEolMilestone":{"description":"Next hardware end-of-life milestone that is coming up. If the device is already LDoS, it will not have a next milestone","type":"string","nullable":true,"example":"END_OF_SALE"},"productId":{"description":"The alphanumeric unique identifier of a Cisco Product. The id is used by customers to order Cisco products","type":"string","nullable":true,"example":"ISR4331/K9"},"currentHwEolMilestoneDate":{"description":"Date of the current hardware end-of-life milestone.","type":"string","nullable":true,"example":"2025-01-31"},"nextHwEolMilestoneDate":{"description":"Date of the next hardware end-of-life milestone.","type":"string","nullable":true,"example":"2025-12-31"},"hwEolInstanceId":{"description":"The unique identifier for hardware bulletin","type":"string","example":"12345"}}}},"pagination":{"description":"Pagination details","type":"object","properties":{"page":{"description":"Current page","type":"integer","format":"int32","example":1},"pages":{"description":"Total number of pages","type":"integer","format":"int32","example":3},"rows":{"description":"Number of records on each page","type":"integer","format":"int32","example":20},"total":{"description":"Total number of records","type":"integer","format":"int64","example":56}},"$$ref":"#/components/schemas/Pagination"}},"$$ref":"#/components/schemas/HardwareEol"}}},"headers":{"Cache-Control":{"description":"Cache Control Header","schema":{"type":"string"},"example":"no-cache","$$ref":"#/components/headers/CacheControl"},"TrackingID":{"description":"Tracking ID","schema":{"type":"string"},"example":"1234","$$ref":"#/components/headers/TrackingID"},"Date":{"description":"Timestamp the response was processed","schema":{"type":"string","format":"E, dd MMM yyyy HH:mm:ss z"},"example":"Fri, 27 Jun 2025 09:07:36 GMT","$$ref":"#/components/headers/Date"}},"$$ref":"#/components/responses/HardwareEolResponse"},"400":{"description":"Bad Request","$$ref":"#/components/responses/BadRequestResponse"},"401":{"description":"Unauthorized","$$ref":"#/components/responses/UnauthorizedResponse"},"403":{"description":"Forbidden","$$ref":"#/components/responses/ForbiddenResponse"},"404":{"description":"Not Found","$$ref":"#/components/responses/NotFoundResponse"},"500":{"description":"Internal Server Error","$$ref":"#/components/responses/InternalServerErrorResponse"}},"security":[{"Oauth2":["apis:read"]}],"__originalOperationId":"getHardwareEOL","method":"get","path":"/product-alerts/hardware-eol"}}