get device certificate data - Cisco Catalyst SD-WAN Manager API, Release 20.18 - Cisco DevNet

{"type":"api","title":"get device certificate data","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/744a8207-9965-344e-aed3-d3ef846a4950","info":{"title":"Others","description":"Other APIs\n- Include APIs that do not belong to other categories\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Certificate Management - Device"],"summary":"get device certificate data","description":"get device certificate data","operationId":"getCertificateData","parameters":[{"name":"requestID","in":"query","description":"Request ID parameter","schema":{"type":"string"},"examples":{"requestID":{"description":"requestID","value":"d65f2b6c-c00a-4432-a87d-d2b6269b01b3"}}},{"name":"dataObject","in":"query","description":"Device property as DataObject parameter","schema":{"type":"string"},"examples":{"CSR":{"description":"CSR","value":"CSR"},"UUID":{"description":"UUID","value":"uuid"},"Reachability":{"description":"Reachability","value":"reachability"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"type":"string"},"$$ref":"#/components/schemas/CertificateChain"},"examples":{"Get Record Response":{"description":"Get Record Response","value":{"header":{"columns":[{"title":"Operation Status","property":"state","colorProperty":"globalState","color":[{"key":"Error","value":"ef5350"}],"width":130,"dataType":"string"},{"title":"Controller Type","property":"deviceType","display":"keyvalue","keyvalueProperty":"deviceType","hideable":false,"keyvalue":[{"key":"vsmart","value":"vSmart"},{"key":"vbond","value":"vBond"},{"key":"vmanage","value":"vManage"},{"key":"vedge","value":"WAN Edge"}],"width":120,"dataType":"string"},{"title":"Hostname","property":"host-name","hideable":false,"width":150,"dataType":"string"},{"title":"System IP","property":"system-ip","hideable":false,"width":120,"dataType":"ipv4"},{"title":"Site ID","property":"site-id","width":70,"dataType":"numberStr"},{"title":"Certificate Serial","property":"serialNumber","width":150,"dataType":"string"},{"title":"Expiration Date","property":"expirationDateLong","displayFormat":"DD MMM YYYY h:mm:ss A z","inputFormat":"unix-time","colorProperty":"expirationStatus","hideable":false,"color":[{"key":"warning","value":"ffb300"},{"key":"invalid","value":"ef5350"}],"width":200,"dataType":"date"},{"title":"uuid","property":"uuid","hideable":false,"editable":false,"dataType":"string"},{"title":"vEdge List Status","property":"state_vedgeList","minWidth":80,"dataType":"string"},{"title":"Device IP","property":"deviceIP","width":120,"dataType":"ipv4"}],"fields":[{"property":"state","dataType":"string"},{"property":"deviceType","dataType":"string","display":"keyvalue"},{"property":"certInstallStatus","dataType":"string"},{"property":"host-name","dataType":"string"},{"property":"system-ip","dataType":"ipv4"},{"property":"site-id","dataType":"numberStr"},{"property":"username","dataType":"string"},{"property":"password","dataType":"string"},{"property":"CSR","dataType":"string"},{"property":"CSRDetail","dataType":"string"},{"property":"CertificateDetail","dataType":"string"},{"property":"serialNumber","dataType":"string"},{"property":"expirationDate","dataType":"string"},{"property":"expirationDateLong","dataType":"date"},{"property":"valid","dataType":"string"},{"property":"errorDetail","dataType":"string"},{"property":"requestTokenID","dataType":"string"},{"property":"uuid","dataType":"string"},{"property":"state_vedgeList","dataType":"string"},{"property":"deviceIP","dataType":"ipv4"},{"property":"errorDetail_vedgelist","dataType":"string"},{"property":"activity","dataType":"string"}],"viewKeys":{"uniqueKey":[],"preferenceKey":"grid-Certificate"},"modelNameMapping":{"vAnalytics":"Analytics","vSmart":"Controller","vManage":"Manager","Cloud OnRamp":"Cloud onRamp","vBond":"Validator"}},"data":[{"configuredSystemIP":"172.16.255.26","deviceType":"vbond","serialNumber":"1234570F","ncsDeviceName":"vbond-340ee9f9-1f65-45b8-8ac4-373c6c328a69","configStatusMessage":"In Sync","templateApplyLog":["[5-Jun-2024 12:00:43 UTC] Sync-from successful"],"uuid":"340ee9f9-1f65-45b8-8ac4-373c6c328a69","managementSystemIP":"172.16.255.26","templateStatus":"Success","chasisNumber":"340ee9f9-1f65-45b8-8ac4-373c6c328a69","configStatusMessageDetails":"","configOperationMode":"cli","deviceModel":"vedge-cloud","deviceState":"READY","validity":"valid","platformFamily":"vedge-x86","hardwareVedge":false,"username":"--","rootCertHash":"de482f840e1d005291436e9f2d5d3e46c4a26e5c","state":"Installed","globalState":"normal","valid":"valid","requestTokenID":"dedcbb2a-6e6c-44e0-b934-ce7fe225528e","expirationDate":"Jun 05 11:51:45 2025 GMT","expirationDateLong":1749124305000,"deviceIP":"172.16.255.26","activity":["Installed"],"certInstallStatus":"Installed","personality":"vbond","expirationStatus":"normal","uploadSource":"Auto Discovered","timeRemainingForExpiration":31483095250,"solution":"common","local-system-ip":"172.16.255.26","system-ip":"172.16.255.26","model_sku":"None","host-name":"vm16","sp-organization-name":"vIPtela Inc Regression","version":"20.15.0-12","vbond":"10.0.12.26","vmanage-system-ip":"172.16.255.26","vmanageConnectionState":"connected","lastupdated":1717644904626,"reachability":"reachable","uptime-date":1717586580000,"defaultVersion":"20.15.0-12","organization-name":"vIPtela Inc Regression","availableVersions":[],"lifeCycleRequired":true,"hardwareCertSerialNumber":"NA","subjectSerialNumber":"NA","resourceGroup":"global","id":"NA","tags":[],"draftMode":"Disabled","device-lock":"No","managed-by":"Unmanaged"},{"configuredSiteId":"200","configuredSystemIP":"172.16.255.22","deviceType":"vmanage","serialNumber":"1234570D","ncsDeviceName":"vmanage-c1161cf1-3655-4595-bf3d-27cda3004c06","configStatusMessage":"In Sync","templateApplyLog":["[5-Jun-2024 20:34:54 PDT] Sync-from successful"],"uuid":"c1161cf1-3655-4595-bf3d-27cda3004c06","managementSystemIP":"0.0.0.0","templateStatus":"Success","chasisNumber":"c1161cf1-3655-4595-bf3d-27cda3004c06","configStatusMessageDetails":"","configOperationMode":"cli","deviceModel":"vmanage","deviceState":"READY","validity":"valid","platformFamily":"vmanage","hardwareVedge":false,"username":"--","rootCertHash":"de482f840e1d005291436e9f2d5d3e46c4a26e5c","CSR":"vmanage-c1161cf1-3655-4595-bf3d-27cda3004c06-0.viptela.com","CSRDetail":"-----BEGIN CERTIFICATE REQUEST-----\nMIIFWDCCA0ACAQAwgdcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh\nMREwDwYDVQQHEwhTYW4gSm9zZTEfMB0GA1UECxMWdklQdGVsYSBJbmMgUmVncmVz\nc2lvbjEWMBQGA1UEChMNQ2lzY28gU3lzdGVtczFDMEEGA1UEAxM6dm1hbmFnZS1j\nMTE2MWNmMS0zNjU1LTQ1OTUtYmYzZC0yN2NkYTMwMDRjMDYtMC52aXB0ZWxhLmNv\nbTEiMCAGCSqGSIb3DQEJARYTc3VwcG9ydEB2aXB0ZWxhLmNvbTCCAiIwDQYJKoZI\nhvcNAQEBBQADggIPADCCAgoCggIBAKnV5Uy7YP7rjV1dvz12FTJomNsM3Fbye+VE\nCiEo2bMOqtTRqvm7VSB3EaULbZgPNw5TfFxEHlvYyuLjPi2n5e5cBOCnMmfDnI4F\n254EekrsYWwrjVPRCdSmSCIwdKAM7hMxtlt68NqAPrn2dBahFZFXEbVPo4QHwdg4\nNPjfY1g73/2pdQNCtGi1+ZaDqB805Eoivdj8+6VZhGp+pPCdHM9Jfmi8SaOu/kAD\np0R0D7SnGDkjnrAAvZbMUYmJ9V2mG0owmogE8DRy56BD7W0lA36K3T63rjU6Jq/8\nrdItymgJHmKee3NoztBUdkKkKR695SkLU+bJx2xv7c8zZuD7z4YEX1JBqyppq5vY\ncChaIlzcVAVMOhc2M4CQTCBwgk2hhucklzdVVmcHfIcIObFUVnu6qrT7v1Og7AvB\nHQIqr13hAbyKEG8ZXoztACTrjmWxrlKrpdzThRmpaOZODROs4zUDAgTrx0gmZ98h\nZQJ2YNyShS2v4h9FETXcUYH6yW616lXo5h3qB35Vrs0IKaWJLI8y5GRlSNpylqJS\n92wpvMD3yYJIgZ+6SzOk+opNnmL0HlUW9g3UWHawDYQTZNYiAonhTPYvACky3Tpb\n9PWqXWHzaxzq+pRuNbO0MfcjGXUQr4coFymb1oYYOn6+l1HBYAlDVj8PqUrlFqm8\nMSz5xaedAgMBAAGgOzA5BgkqhkiG9w0BCQ4xLDAqMAkGA1UdEwQCMAAwHQYDVR0O\nBBYEFFMWOUNr5K8j/GjjRZkAOenJpMDbMA0GCSqGSIb3DQEBCwUAA4ICAQBu7vXf\nfGBSYFri/UXPWUlnRLf4bvIo5iJVxt/PCw3+V681lCBfJp/cGo6uHKsOWJ4N84DH\nlmidgVUK2lYtI3NbRQJfeu20NhAX4wD4CPTIZHG5f5r06qgyS633og6D2ISddg5F\n+RpyVXfsYIBVT0MydVMrDT1PWOaq7dvJ18WaesWXWtAHorgees1wMBiXaWjHR7f2\n7x315QzHlEYEoO0JECkt0EBcwju1HLgJD3ow66NTi9CLu/RR+wSg31NpjlxK4is+\n8eh/GII2xJwwrxQ4eJv4Ogmt7FchbPQtDaezZu0L8BqJcvyWAv+KEGzRKXncxULM\n3edGVrEHH0NkRYUcK4WqN4z3fDPRcSt+1TwWelZhyR2FVT1xUp0/i8Lmbu1QU4Da\njTID1ixdGJdUpMVEuVwTTtqXN6Nf0oWsKOe06prX9xVTrCYVCqnsRroCSiVgkOAZ\nWFgnonUH9smzWnCZeLtb43rLihcdYoolC1xFvQcC9VspuVmSzpO/FM0v02mR4UnJ\nrWQZ+kDrbhPy7OldBEv1DdAEExVZkK1otO9AKRqGP6e8cMFL+Ui4D82Yh/TukQO2\nX9Z4S5T+wTu1txVUXWLwrnUd3mur8caXs13NeRpINIXPjHQf8G+zM/C2L9AZ1bVz\neN0u1l3WpURqBUmJj+9br8AqRURIikoWxA4SCQ==\n-----END CERTIFICATE REQUEST-----","certificateDetail":"-----BEGIN CERTIFICATE-----\nMIIEmDCCA4ACBBI0Vw0wDQYJKoZIhvcNAQELBQAwbTELMAkGA1UEBhMCVVMxEzAR\nBgNVBAgMCkNhbGlmb3JuaWExETAPBgNVBAcMCFNhbiBKb3NlMRQwEgYDVQQKDAt2\nSVB0ZWxhIEluYzEgMB4GCSqGSIb3DQEJARYRbm9yZXBseUBjaXNjby5jb20wHhcN\nMjQwNjA1MTE1MTI1WhcNMjUwNjA1MTE1MTI1WjCBszERMA8GA1UEBxMIU2FuIEpv\nc2UxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMRYwFAYDVQQKEw1D\naXNjbyBTeXN0ZW1zMR8wHQYDVQQLExZ2SVB0ZWxhIEluYyBSZWdyZXNzaW9uMUMw\nQQYDVQQDEzp2bWFuYWdlLWMxMTYxY2YxLTM2NTUtNDU5NS1iZjNkLTI3Y2RhMzAw\nNGMwNi0wLnZpcHRlbGEuY29tMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKC\nAgEAqdXlTLtg/uuNXV2/PXYVMmiY2wzcVvJ75UQKISjZsw6q1NGq+btVIHcRpQtt\nmA83DlN8XEQeW9jK4uM+Lafl7lwE4KcyZ8OcjgXbngR6SuxhbCuNU9EJ1KZIIjB0\noAzuEzG2W3rw2oA+ufZ0FqEVkVcRtU+jhAfB2Dg0+N9jWDvf/al1A0K0aLX5loOo\nHzTkSiK92Pz7pVmEan6k8J0cz0l+aLxJo67+QAOnRHQPtKcYOSOesAC9lsxRiYn1\nXaYbSjCaiATwNHLnoEPtbSUDfordPreuNTomr/yt0i3KaAkeYp57c2jO0FR2QqQp\nHr3lKQtT5snHbG/tzzNm4PvPhgRfUkGrKmmrm9hwKFoiXNxUBUw6FzYzgJBMIHCC\nTaGG5ySXN1VWZwd8hwg5sVRWe7qqtPu/U6DsC8EdAiqvXeEBvIoQbxlejO0AJOuO\nZbGuUqul3NOFGalo5k4NE6zjNQMCBOvHSCZn3yFlAnZg3JKFLa/iH0URNdxRgfrJ\nbrXqVejmHeoHflWuzQgppYksjzLkZGVI2nKWolL3bCm8wPfJgkiBn7pLM6T6ik2e\nYvQeVRb2DdRYdrANhBNk1iICieFM9i8AKTLdOlv09apdYfNrHOr6lG41s7Qx9yMZ\ndRCvhygXKZvWhhg6fr6XUcFgCUNWPw+pSuUWqbwxLPnFp50CAwEAATANBgkqhkiG\n9w0BAQsFAAOCAQEAh83Rf2izgvRsaaK7bIPQzwSkcxyiPIan2ETfSSRZyJO4/0Hz\no6QU54HnOfxDvDvAYvaB0gv9sKiKG8vSJCglm7+RibdyOaHHCXepl4Bsk9InUKQD\nl+c/Gkdwlx6NwsDHAZ7JDAogE5Mcq2s2Zg28MQAfVPKt8ZNOTAY201dTmSiux0G2\nt9/V6DtyiWtJvSOZGXVzth3azRnnl3NHk9qv+jZN/suMXa6Ie3SEPnonececvOuU\nVpJ5nMe9gIh7vt/8HpIGjj+u810oylwQTDuZThAPo3YhIhSrJEll7QOZ1bzjK00e\nEn7qdGnmmN+WGjHANIfDga8/p0Q5SlPhpPkNfQ==\n-----END CERTIFICATE-----","state":"vBond Updated","globalState":"normal","valid":"valid","requestTokenID":"46fcfa6f-970b-4ac9-93ce-153a8efdedcb","expirationDate":"Jun 05 11:51:25 2025 GMT","expirationDateLong":1749124285000,"deviceIP":"172.16.255.22","activity":["vBond Updated"],"state_vedgeList":"Sync","certInstallStatus":"Installed","servicePersonality":"all","personality":"vmanage","expirationStatus":"normal","timeRemainingForExpiration":31483075250,"solution":"common","domain-id":"0","local-system-ip":"172.16.255.22","system-ip":"172.16.255.22","model_sku":"None","site-id":"200","host-name":"vm12","sp-organization-name":"vIPtela Inc Regression","version":"20.15.0-12","vbond":"10.0.12.26","vmanage-system-ip":"172.16.255.22","vmanageConnectionState":"connected","lastupdated":1717644911366,"reachability":"reachable","uptime-date":1717586940000,"defaultVersion":"20.15.0-12","organization-name":"vIPtela Inc Regression","availableVersions":[],"lifeCycleRequired":false,"hardwareCertSerialNumber":"NA","subjectSerialNumber":"NA","resourceGroup":"global","id":"NA","tags":[],"draftMode":"Disabled","site-name":"SITE_200","device-lock":"No","managed-by":"Unmanaged"},{"configuredSiteId":"100","configuredSystemIP":"172.16.255.19","deviceType":"vsmart","serialNumber":"1234570A","ncsDeviceName":"vsmart-8ebb56fd-aa0f-4e65-8f9e-6998f56ff40d","configStatusMessage":"In Sync","templateApplyLog":["[5-Jun-2024 12:03:00 UTC] Sync-from successful"],"uuid":"8ebb56fd-aa0f-4e65-8f9e-6998f56ff40d","managementSystemIP":"172.16.255.19","templateStatus":"Success","chasisNumber":"8ebb56fd-aa0f-4e65-8f9e-6998f56ff40d","configStatusMessageDetails":"","configOperationMode":"cli","deviceModel":"vsmart","deviceState":"READY","validity":"valid","platformFamily":"vsmart","hardwareVedge":false,"username":"--","rootCertHash":"de482f840e1d005291436e9f2d5d3e46c4a26e5c","state":"vBond Updated","globalState":"normal","valid":"valid","requestTokenID":"1f8cf805-6058-4811-80a3-7d6727f5b5ee","expirationDate":"Jun 05 11:51:17 2025 GMT","expirationDateLong":1749124277000,"deviceIP":"172.16.255.19","activity":["vBond Updated"],"certInstallStatus":"Installed","personality":"vsmart","expirationStatus":"normal","uploadSource":"Auto Discovered","timeRemainingForExpiration":31483067250,"region-id":[],"solution":"sdwan","policy-template-version":"","domain-id":"1","policy-template-name":"","local-system-ip":"172.16.255.19","system-ip":"172.16.255.19","model_sku":"None","site-id":"100","host-name":"vm9","sp-organization-name":"vIPtela Inc Regression","version":"20.15.0-12","vbond":"10.0.12.26","vmanage-system-ip":"172.16.255.19","vmanageConnectionState":"connected","lastupdated":1717644906473,"reachability":"reachable","uptime-date":1717586580000,"defaultVersion":"20.15.0-12","organization-name":"vIPtela Inc Regression","availableVersions":[],"lifeCycleRequired":false,"hardwareCertSerialNumber":"NA","subjectSerialNumber":"NA","resourceGroup":"global","id":"NA","tags":[],"draftMode":"Disabled","site-name":"SITE_100","device-lock":"No","managed-by":"Unmanaged"},{"configuredSiteId":"200","configuredSystemIP":"172.16.255.20","deviceType":"vsmart","serialNumber":"1234570B","ncsDeviceName":"vsmart-5fa14c76-4b50-4b9a-9e44-803881c5172d","configStatusMessage":"In Sync","templateApplyLog":["[5-Jun-2024 12:02:52 UTC] Sync-from successful"],"uuid":"5fa14c76-4b50-4b9a-9e44-803881c5172d","managementSystemIP":"172.16.255.20","templateStatus":"Success","chasisNumber":"5fa14c76-4b50-4b9a-9e44-803881c5172d","configStatusMessageDetails":"","configOperationMode":"cli","deviceModel":"vsmart","deviceState":"READY","validity":"valid","platformFamily":"vsmart","hardwareVedge":false,"username":"--","rootCertHash":"de482f840e1d005291436e9f2d5d3e46c4a26e5c","state":"vBond Updated","globalState":"normal","valid":"valid","requestTokenID":"005c43b2-ab84-4407-991c-d3bf621a7c44","expirationDate":"Jun 05 11:51:16 2025 GMT","expirationDateLong":1749124276000,"deviceIP":"172.16.255.20","activity":["vBond Updated"],"certInstallStatus":"Installed","personality":"vsmart","expirationStatus":"normal","uploadSource":"Auto Discovered","timeRemainingForExpiration":31483066250,"region-id":[],"solution":"sdwan","policy-template-version":"","domain-id":"1","policy-template-name":"","local-system-ip":"172.16.255.20","system-ip":"172.16.255.20","model_sku":"None","site-id":"200","host-name":"vm10","sp-organization-name":"vIPtela Inc Regression","version":"20.15.0-12","vbond":"10.0.12.26","vmanage-system-ip":"172.16.255.20","vmanageConnectionState":"connected","lastupdated":1717644906446,"reachability":"reachable","uptime-date":1717586520000,"defaultVersion":"20.15.0-12","organization-name":"vIPtela Inc Regression","availableVersions":[],"lifeCycleRequired":false,"hardwareCertSerialNumber":"NA","subjectSerialNumber":"NA","resourceGroup":"global","id":"NA","tags":[],"draftMode":"Disabled","site-name":"SITE_200","device-lock":"No","managed-by":"Unmanaged"}]},"$$ref":"#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetrecordresponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"method":"get","path":"/certificate/record"}}