{"type":"api","title":"Update a serial number","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/6c38d1fe-54c3-3c7d-9226-ba8b795939ba","info":{"title":"Crosswork ZTP Service API","description":"Crosswork ZTP Service API for devices, profiles, serial numbers, and static routes. These APIs permit users to add, update, delete, query, and perform bulk CSV import/export of devices and device onboarding operations using ZTP services.","version":"7.1.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/ztp-service-deprecated-api-overview.md"}},"openapi":"3.0.1","servers":[{"url":"/crosswork/ztp/v1"}],"securitySchemes":{"bearerAuth":{"description":"Security definitions details.","in":"header","name":"Authorization","type":"apiKey"}}},"spec":{"operationId":"UpdateSerialNumber","deprecated":true,"requestBody":{"content":{"application/json":{"schema":{"description":"Serial Number object.","properties":{"isInUse":{"description":"either \"true\" or \"false\"","type":"string"},"isOvLinked":{"description":"either \"true\" or \"false\"","type":"string"},"modifiedDate":{"format":"int64","description":"last modified date in unix time format","type":"integer"},"ovContent":{"description":"base64 enc string of ownership voucher file","type":"string"},"ovFilename":{"description":"ownership voucher file name","type":"string"},"serialNumber":{"description":"The serial number of the device","type":"string"}},"type":"object","$$ref":"#/components/schemas/cwztpsvcZtpSerialNumber"},"example":{"serialNumber":"FOC2709R2FN","ovFilename":"FOC2709R2FN.vcj","ovContent":"MO+/vRTvv70GCSrvv71I73+977+9DQEHAu+/Ve+/vRTvv70w77+9FO+/vQIBATENmAsGCWDvv71IAWUDBAIbmO+/vQlkBgkq77+9do+/ve+/vQ0BBwHvv73vv70JVQTvv70JUXsiaWV0Zi12b3VjaGVyOnZvdWNoZXIiOiB7ImNyZWF0ZWQtb24iOiAiMjAyNC0wNS0wOVQxMTozMjozOC42NzUxMDNaIiwgImV4cGlyZXMtb24iOiAiMjAyNS0wNS0wOVQxMTozMjozOC42NzUxMDNaIiwgImFzc2VydGlvbiI6ICJsb2dnZWQiLCAic2VyaWFsLW51bWJlciI6ICJGT0MyNzA5UjJGTiIsICJwaW5uZWQtZG9tYWluLWNlcnQiOiAiTUlJR1BEQ0NCQ1NnQXdJQkFnSVVXL2VldlIvckVqckF3Q2tYbmxJL3ludlBOMGN3RFFZSktvWklodmNOQVFFTEJRQXdjakVMTUFrR0ExVUVCaE1DU1U0eEN6QUpCZ05WQkFnTUFrdEJNUXd3Q2dZRFZRUUhEQU5DUjB3eEdqQVlCZ05WQkFvTUVVTkpVME5QSUZOWlUxUkZUVk1nU1U1RE1RNHdEQVlEVlFRTERBVlNUMEpQVkRFY01Cb0dBMVVFQXd3VFdsUlFJRWx1ZEdWeWJtRnNJRkJFUXlCRFFUQWVGdzB5TkRBMU1Ea3hNVEV5TXpOYUZ3MDBOREExTURReE1URXlNek5hTUhJeEN6QUpCZ05WQkFZVEFrbE9NUXN3Q1FZRFZRUUlEQUpMUVRFTU1Bb0dBMVVFQnd3RFFrZE1NUm93R0FZRFZRUUtEQkZEU1ZORFR5QlRXVk5VUlUxVElFbE9RekVPTUF3R0ExVUVDd3dGVWs5Q1QxUXhIREFhQmdOVkJBTU1FMXBVVUNCSmJuUmxjbTVoYkNCUVJFTWdRMEV3Z2dJaU1BMEdDU3FHU0liM0RRRUJBUVVBQTRJQ0R3QXdnZ0lLQW9JQ0FRRFFnZ2ttSnNQenpVaFlMNm5YRElnUGhmTERiQkh1YWI2SkpxZTIzUXk4VncreVAvcnZQbFhrbFJtNUtDZXFWN0lpb1I3YStuQmo1THFWbXpYSVFDL1U2b3dvRndVVGJIRXhDWXdsY3lZMURxQnJMOEFLRHh2cktsR0k5Wk1UdE4wMnViNkpxbzVpRE9MajVDYU5MWVJVT3Ixa2JKZmxyUzZnQWZZdkwwcjJZR01sblQwbXVFbUJmdzM1citFWXpickJCTkhBRmQrUUNkaHRiQWE4L0NTbGE5U3VrLzRKZ0xQNDBFTWFQeUFHOUlMOSt1V0phQnZaMGVVOURuUXdMRk9vMGYxVlhtbFdrYmRhVVo2enR4TVFNY0RmYWRWSkZpekZEUWp6Z0dQZXNsSnNhME45d01JWWo5c2pGUkpRdmhqOXIzSmk5ME1qOFgvaU85b1FDSmlpNmxGMXNQV0xMSVdTMk4rK0g1cWoyRFpIY05Dc1ZHRUJCWnc1alhUWGhLOE1xZGlzOVZ6aElNNEo5Qy90NGJxT0F6RnRBdFJGOG1nZWgvWVV3Q2dXK05NSDZoeCtXV1JFZEVHSjZFTE9WVlZyZ1NDQUVER1I3eHM4a2tEeldGVUVtZDd3WU9zK29Yc21OdXJDL3krL1NscVBhaGVHOEJFZ1NLUjR1dlZNekFXNk1WLytNQjNtdW5DRnZwTmx1d3lNN3FHTGhPR3dYTGdqZ2NTZmJHL1crVE1NN2lZTnEyY3JYMHJQOEVlanE0UFhyc1NCakdTSmhrNld4Z29QdERHL0xldC8yblFVS3NyQmsxR01vV1YvUlVRME9mRCtjMkNrMVZUMTRDdStEOWRrWnZ6YTY1dVVkVmF4Wm9FT2NkZUkzSUt5aVdpNm11WmtEYitHRjhydWZ3SURBUUFCbzRISk1JSEdNQjBHQTFVZERnUVdCQlQvUFRsRm0zeHUvQU9id2ptT0JjNUlwOHVxTHpBZkJnTlZIU01FR0RBV2dCVC9QVGxGbTN4dS9BT2J3am1PQmM1SXA4dXFMekFQQmdOVkhSTUJBZjhFQlRBREFRSC9NQTRHQTFVZER3RUIvd1FFQXdJQmhqQmpCZ05WSFJFRVhEQmFnaFZsY0c0dGMzWnRMVEUyTlM1amFYTmpieTVqYjIyQ0tXUnZZMnRsY2kxeVpXZHBjM1J5ZVM1a1pXWmhkV3gwTG5OMll5NWpiSFZ6ZEdWeUxteHZZMkZzaHdRS1RsaWxod1FLVGxPNmh3UUtUbGg2aHdRS1RsTzVNQTBHQ1NxR1NJYjNEUUVCQ3dVQUE0SUNBUUFCclRMemw0WUlhakFRZXJhV082OStjSG1LYkJjb0syN0FVNldtVzhTYis0UVRMUUdUb1BDL015YXBaN2pTL1c3Z05jT3BwTmUxUWdwT1Z0VFRmQVJwY3hkSXhrMUtiRkd1YlFwRGtlR3psMjhnOFNPTXpNMjhPT3dPQWt1d2ZTZStPQVQ2Q1RiOUp6VU5RVlc3V2JGblhTbzZHRlpkbGlnTWVWMTBLZEU4bm43L3ptMlZ1bUp0Nk5XTjVDYkZlRms1ZWxPM01CV1RCMmlINm13UTIyL2xaaVVjRG0wWFVDTEhsN3ZKRzFhRlc4d1BiWWxoVisxZ3JZeVhNbi9jTndRRDdjbGp3bWpSeGx3MjdZbkJaU1E3SVFXcHlPOWVzQkVLZU5RdmdPbzMydERzWTMxam5QRXJsUVd5VlRUYW9JRXhUZ04rOXdZVVEzdEtZUWF5dll1Njc3UUJ3WHBYRGFySE1MMnEvMHlLcWg5RTR0a01rMGZWUEFKSXp3UEt3S2h2djRPOXg1OXBJaXFRWFBCalpnUkhUSGFqT2huaVcvdnUvMnYyYnR3bUJuemtkZzNnTzhqa2JXQ0FLRXlhZi9NMVM0YmlRd3lvUTJSOVdiRmdqbmZGTjFxNHhDWnMrT2JrcFh1K2cwUEhiU0swbUVaZGFheW9tUVl1bUFlbWRmcStaV0lMaW9YMUZtMXNDRkRHSVpLSE01NTJNZ2J4cnh0dXF4TUM4MXd3MlBWaUZxVWZxZjlucmdYQnJLZWp0UnlObWRLeUhFc3R2S2IrOW43ZjQ3N0ZZcTl6TDUzSmVRT3A1NmdKRVNTWVd3VXMyS1c5S3hkSDAvVWcwNzhDeStEY28wU2FtclR1allWWTlNOVd6UWlkc3c5VWlrU3dNVUthMVFQYUkwUTdBUT09IiwgImxhc3QtcmVuZXdhbC1kYXRlIjogIjIwMjUtMDUtMDlUMTE6MzI6MzguNjc1MTAzWiJ9fe+/ve+/vQjvv70w77+9BBww77+9AwTvv70DAgECAgkA77+92anvv70uXe+/vTwwDQYJKu+/vUjvv73vv70NAQELBQAwNjEWMBQGA1UEAwwNSU9TLVhSLVNXLUNQSzEMMAoGA1UECwwDUkVMMQ4wDAYDVQQKDAVDaXNjbzAeFw0yMTA0MjgxOTE5MTFaFw0zNTEyMjkxOTE5MTFaMDkxGTAXBgNVBAMMEElPUy1YUi1TVy1DUEstT1YxDDAKBgNVBAsMA1JFTDEOMAwGA1UECgwFQ2lzY28w77+9ASIwDQYJKu+/vUjvv73vv70NAQEBBQAD77+9AQ8AMO+/vQEKAu+/vQEBAO+/ve+/veyIkkEV77+9c000OO+/ve+/vRUqW++/vUwdbu+/ve+/vUDvv70L77+9Am5BCVlh77+9Yxbvv719Pnzvv73vv71BMzrjkJ1H77+977+9Je+/vWcb77+9cO+/ve+/vQfvv70377+9Du+/vWto77+977+977+977+9FxrDs1IK77+977+977+977+9ETnvv73vv73vv73vv73WlR8Q77+977+9OO+/vTU077+977+9BQ5ubF8G77+977+9R++/ve+/ve+/vRMrce+/vdma77+9AMW977+9Fe+/vdOsBu+/vUJpSu+/vUA4YO+/ve+/vQbvv71OTe+/vXMCK3A1Gu+/vVDvv71QEnjvv71KMH7vv71G77+9IO+/vRvvv70UXn9b77+9Yu+/vXnvv73vv70V77+98Ke1se+/vRR477+9aiwEHTDvv73vv70LOw4zBxDvv700WWAz77+9RURZM++/vSXvv73vv73vv73vv70p77+977+9N03vv709YQVB77+9cu+/ve+/ve+/vQx9yLN577+9SO+/vQTvv70677+9NE9+77+9C++/ve+/vc6nLidARBxnAgMBAAHvv73vv70BKDDvv70BJDAJBgNVHRMEAjAAMAsGA1UdDwQEAwIH77+9MB8GA1UdIwQYMBbvv70Uc++/ve+/vUkG77+977+9VWtG77+9bu+/vSQh77+977+977+977+9MEQGA1UdHwQ9MDswOe+/vTfvv70177+9M2h0dHA6Ly93d3cuY2lzY28uY29tL3NlY3VyaXR5L3BraS9jcmwvY3JjcGtjYXhyLmNybDBEBggrBgEFBQcBAQQ4MDYwNAYIKwYBBQUHMAHvv70oaHR0cDovL3Rvb2xzLmNpc2NvLmNvbS9wa2kvc2VydmljZXMvb2NzcDBdBgNVHSAEVjBUMFIGCysGAQQBCRUBJAAEMEMwQQYIKwYBBQUHAgEWNWh0dHA6Ly93d3cuY2lzY28uY29tL3NlY3VyaXR5L3BraS9wb2xpY2llcy9pbmRleC5odG1sMA0GCSrvv71I77+977+9DQEBCwUAA++/vQEBAO+/ve+/ve+/ve+/vTF1Mxjvv70N77+977+9bToh77+9Rys077+9du+/vV5X77+9GWJ2cSDvv70/CwHvv70K77+9Hu+/vSnEmFolNBMH77+977+9IhEs77+9AnLvv73vv70vLFVcVC573JPYiu+/vUnvv71r77+9JO+/ve+/vdqfRTnvv73vv73vv73thIcW77+9NU3vv71A77+977+977+9d++/vSPvv73vv73vv73vv73ahO+/ve+/ve+/ve+/vXLvv71xNQQJBBLvv71ZNe+/vQ/vv70HNu+/vX1VUyzvv71X77+9DXPvv73vv73vv73vv70aBBjvv73vv710LO+/vRTvv73vv70+G++/ve+/vSPvv71277+977+977+977+977+977+9ZxwKcu+/vUXvv71M77+977+9I0jvv73vv71P77+977+9P++/vU9s77+977+9PO+/vSJA77+9IyxoeUtPM2nvv73vv71QJzMb77+9D++/ve+/vXAk77+977+977+977+9Nx9eQmHvv73TgQzvv71uDyTvv73vv70k77+977+9V++/ve+/vWhbZO+/vT5O77+977+9VO+/ve+/ve+/vXMWIe+/vTDvv70E77+9MO+/vQNy77+9AwIBAgIJAO+/vWLvv73RgnhAMA0GCSrvv71I77+977+9DQEBCwUAMDYxFjAUBgNVBAMMDUlPUy1YUi1TVy1DUEsxDDAKBgNVBAsMA1JFTDEOMAwGA1UECgwFQ2lzY28wHhcNMTgwODE0MDQzNzU1WhcNMzUxMjMwMDQzNzU1WjA2MRYwFAYDVQQDDA1JT1MtWFItU1ctQ1BLMQwwCgYDVQQLDANSRUwxDjAMBgNVBAoMBUNpc2NvMO+/vQEiMA0GCSrvv71I77+977+9DQEBAQUAA++/vQEPADDvv70BCgLvv70BAQDvv73vv73vv70vXgfvv71n77+9Jj0V77+9R++/ve+/vS3vv71+PFZhSu+/vS3vv71m77+9RC8tPO+/vU1cdGkN77+977+977+977+9UO+/veyxrxjvv73vv71dOyzvv73vv73vv70sG++/ve+/ve+/vXF777+977+977+9zJbhg77vv71Y77+9Dw7Yswbvv71DOWXvv71J77+977+977+9CiMBYzLvv70XA1wmVFzvv70vaShKPx0PDu+/vTPvv708eu+/ve+/vV0f77+9dwTvv71qNu+/vV8Qy5vvv71SXA0j77+977+9Wu+/vSzvv73vv73vv70DTe+/ve+/vQXvv73vv73vv71x77+9Le+/vRUnF++/ve+/vXUW77+977+977+9T++/vVhT77+977+9e++/ve+/vT5Y77+9Gu+/vSbvv71ObEzvv73vv73vv70YMDfvv73vv73vv70k05zilaMh77+9HAIE57as77+977+977+9xbLvv73vv73vv71/RO+/vSTDv++/vcuI77+977+9F++/vVlNAu+/vRXvv73vv73vv73vv70A77+977+9Vjzvv73vv73vv71L77+9Ic2XAgMBAAHvv73vv70B77+9MO+/vQHvv70wEgYDVR0TAQHvv70ECDAGAQHvv70CAQAwDgYDVR0PAQHvv70EBAMCAQYwHQYDVR0OBBYEFHPvv73vv71JBu+/ve+/vVVrRu+/vW7vv70kIe+/ve+/ve+/ve+/vTBEBgNVHR8EPTA7MDnvv70377+9Ne+/vTNodHRwOi8vd3d3LmNpc2NvLmNvbS9zZWN1cml0eS9wa2kvY3JsL2NyY2FjcGt4ci5jcmwwRAYIKwYBBQUHAQEEODA2MDQGCCsGAQUFBzAB77+9KGh0dHA6Ly90b29scy5jaXNjby5jb20vcGtpL3NlcnZpY2VzL29jc3AwZgYDVR0jBF8wXe+/vRRz77+977+9SQbvv73vv71Va0bvv71u77+9JCHvv73vv73vv73vv70677+9ODA2MRYwFAYDVQQDDA1JT1MtWFItU1ctQ1BLMQwwCgYDVQQLDANSRUwxDjAMBgNVBAoMBUNpc2Nv77+9CQDvv71i77+90YJ4QDBcBgNVHSAEVTBTMFEGCisGAQQBCRUBJAIwQzBBBggrBgEFBQcCARY1aHR0cDovL3d3dy5jaXNjby5jb20vc2VjdXJpdHkvcGtpL3BvbGljaWVzL2luZGV4Lmh0bWwwDQYJKu+/vUjvv73vv70NAQELBQAD77+9AQEAB++/vU/vv70777+977+977+9Su+/vX8SGzXvv71477+977+977+9M++/ve+/ve+/vUzvv70S77+977+9Dg3vv71mFkXvv70yd0vvv73vv71m77+9akrvv71x77+9ZF4NK23vv73vv73vv71GQAzvv73vv73vv70+77+9Zmrvv73vv70WE++/vUrvv71T77+977+9Ou+/ve+/vVHvv73vv73vv73vv71mWUEy77+9d++/vTvvv73vv70xK++/vWhS77+9Ce+/vUc3Ou+/vRIt77+9P++/vWcH77+977+977+9DO+/vcSTAgrvv70R77+9RVDRp++/vTFYIVY777+9W++/ve+/ve+/ve+/vQzvv70rFiMLXu+/ve+/ve+/ve+/vTTvv71+S++/vXbvv73vv73vv71LSRDvv71H77+92Ibvv73vv70s77+9ZO+/ve+/vQ/vv73vv71JKO+/ve+/ve+/vQzvv70+P++/ve+/vWLvv70z77+90b7vv73vv73vv70F77+9dntQQWbvv73vv70C77+977+977+9KncU77+9Wzsc36Dvv71K77+94K24Q++/vRV+Ge+/vVh177+977+977+977+977+9OGrvv70rURF/77+9Vx4o77+9YO+/vTHvv70CUzDvv70CTwIBATBDMDYxFjAUBgNVBAMMDUlPUy1YUi1TVy1DUEsxDDAKBgNVBAsMA1JFTDEOMAwGA1UECgwFQ2lzY28CCQDvv73Zqe+/vS5d77+9PDALBglg77+9SAFlAwQCAe+/ve+/ve+/vTAYBgkq77+9SO+/ve+/vQ0BCQMxCwYJKu+/vUjvv73vv70NAQcBMBwGCSrvv71I77+977+9DQEJBTEPFw0yNDA1MDkxMTMyMzlaMC8GCSrvv71I77+977+9DQEJBDEiBCDvv71m77+9f1jvv70udwfvv73vv70OUOKMtu+/ve+/vT0J77+9Q++/ve+/ve+/vVom77+977+9JCoweQYJKu+/vUjvv73vv70NAQkPMWwwajALBglg77+9SAFlAwQBKjALBglg77+9SAFlAwQBFjALBglg77+9SAFlAwQBAjAKBggq77+9SO+/ve+/vQ0DBzAOBggq77+9SO+/ve+/vQ0DAgICAO+/vTANBggq77+9SO+/ve+/vQ0DAgIBQDAHBgUrDgMCBzANBggq77+9SO+/ve+/vQ0DAgIBKDANBgkq77+9SO+/ve+/vQ0BAQEFAATvv70BAO+/ve+/vV/vv71gQGPvv70GLu+/vSzvv73vv71K77+9RO+/ve+/ve+/vQHvv73vv70aKX7vv73vv71d77+977+9C2nvv70+77+977+9AiTvv73vv71N77+9KU5+77+9H3lazpLvv70O77+977+977+9xqcpZ++/ve+/ve+/vQIZeu+/vR7Qgu+/vU0yYS1r77+977+9S0sK77+977+977+977+9Mu+/ve+/vSIu77+9Vu+/vSAU77+9LDtOTgTvv70WSe+/ve+/vXss77+9Re+/ve+/ve+/vS7vv73vv70gSO+/vQttFe+/vWA/77+977+9MkDvv71BCe+/vTfvv71KRO+/ve+/ve+/ve+/vT3vv73vv71GShPvv706Di3vv73vv73vv71W77+9IWrvv73vv703HmkJOBjvv70B77+977+977+9TBg277+977+9cu+/vRhUWu+/ve+/vV4LPWHvv73vv70A77+977+9eVZQ77+9Vkrvv73vv73vv70+77+977+977+977+9PDzbqXU1EyDvv70Z77+9EFwhEO+/ve+/vV5AVO+/ve+/vTdH77+9NB7apz5DLwTbge+/vX5pWgHvv71U77+977+9fQ=="}}},"description":"The information used to update serial number.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"description":"Serial Number response object.","properties":{"code":{"description":"Response code. Indicates success/failure.","format":"int32","type":"integer"},"data":{"description":"List of Serial Number object data.","items":{"description":"Serial Number object.","properties":{"isInUse":{"description":"either \"true\" or \"false\"","type":"string"},"isOvLinked":{"description":"either \"true\" or \"false\"","type":"string"},"modifiedDate":{"format":"int64","description":"last modified date in unix time format","type":"integer"},"ovContent":{"description":"base64 enc string of ownership voucher file","type":"string"},"ovFilename":{"description":"ownership voucher file name","type":"string"},"serialNumber":{"description":"The serial number of the device","type":"string"}},"type":"object","$$ref":"#/components/schemas/cwztpsvcZtpSerialNumber"},"type":"array"},"message":{"description":"Response message. Indicates success/failure reason.","type":"string"},"pagination":{"description":"Used to filter results, paginationin device and other APIs.","properties":{"Criteria":{"description":"Response filter criteria. Not used.","type":"string"},"Descending":{"description":"Order response in ascending/descending order. Default value: \"false\"","format":"boolean","type":"boolean"},"MatchCase":{"description":"Do case matching. Not used.","format":"boolean","type":"boolean"},"PageNum":{"description":"Page number in the list of generated records, paginated by \"PageSize\". Starts with 0.","format":"int64","type":"integer"},"PageSize":{"description":"Number of records to be returned in a response.","format":"int64","type":"integer"},"SortBy":{"description":"Field to be used for sorting responses.","type":"string"},"TotalCount":{"description":"Total number of records matching the query criteria.","format":"int64","type":"integer"}},"type":"object","$$ref":"#/components/schemas/cwztpsvcZtpFilterData"}},"type":"object","$$ref":"#/components/schemas/cwztpsvcZtpSerialNumberResponse"},"examples":{"Success Response":{"value":{"data":[{"serialNumber":"1","isOVLinked":"false","isInUse":"false","modifiedDate":1685732976}],"pagination":{"TotalCount":1},"code":200,"message":"Serial Number is successfully updated."}},"Invalid Input":{"value":{"code":400,"message":"Serial Number is missing."}},"Serial Number Not Found":{"value":{"code":404,"message":"Serial Number doesn't exist."}},"Invalid Request Body":{"summary":"Invalid Request Body","value":{"code":422,"message":"invalid character '}' looking for beginning of value"},"$$ref":"#/components/examples/Invalid_Request_Body"},"Internal Server Error":{"value":{"code":500,"message":"Failed to save data. DB error."}},"Service Unavailable":{"value":{"code":503,"message":"Sorry, ztp service is in maintenance mode. Only read operations are supported."}}}}},"description":"OK. The request was successful. The result is contained in the response body."},"401":{"description":"Unauthorized. The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden. The server recognizes the authentication credentials, but the client is not authorized to perform this request."},"404":{"description":"Not Found. The client made a request for a resource that does not exist."}},"summary":"Update a serial number","description":"Allows users to update a serial number.","tags":["Voucher & Serial Number APIs"],"__originalOperationId":"UpdateSerialNumber","security":[{"bearerAuth":[]}],"method":"put","path":"/serialnumbers"}}