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

{"type":"api","title":"get controller 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 controller certificate data","description":"get controller certificate data","operationId":"getCertificateControllerListData","parameters":[{"name":"requestID","in":"query","description":"Request ID parameter","schema":{"type":"string"},"examples":{"Empty":{"description":"Empty"},"requestID":{"description":"requestID","value":"d65f2b6c-c00a-4432-a87d-d2b6269b01b3"}}},{"name":"dataObject","in":"query","description":"Device property as DataObject parameter","schema":{"type":"string"},"examples":{"Empty":{"description":"Empty"},"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":{"Certificate Data Response":{"description":"Certificate Data Response","value":{"header":{"columns":[{"title":"State","property":"certInstallStatus","display":"iconAndToolTip","iconProperty":"certInstallStatus","toolTipProperty":"certInstallStatus","hideable":false,"icon":[{"key":"CSR Generated","value":"images/certStates/csr-generated.png","displayKey":"CSR Generated"},{"key":"CSR Generation Error","value":"images/certStates/csr-failed.png","displayKey":"CSR Failed"},{"key":"Certificate Installation Error","value":"images/certStates/cert-install-failed.png","displayKey":"Certificate Installation Failed"},{"key":"Installed","value":"images/certStates/cert-installed.png","displayKey":"Certificate Installed"}],"width":40,"minWidth":40,"dataType":"string"},{"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":"Controller"},{"key":"vbond","value":"Validator"},{"key":"vmanage","value":"Manager"},{"key":"vedge","value":"WAN Edge"}],"width":120,"dataType":"string"},{"title":"Site Name","property":"site-name","hideable":true,"width":100,"dataType":"string"},{"title":"Hostname","property":"host-name","hideable":true,"width":100,"dataType":"string"},{"title":"Config Locked","property":"device-lock","visible":true,"width":80,"dataType":"boolean"},{"title":"Managed By","property":"managed-by","visible":true,"headerTooltip":"This field indicates whether device is being managed by a Configuration-Group, Template, or it is Unmanaged i.e. not managed by either of them. Note: A device that is Unlocked but, managed by a Configuration-Group will become locked again when the Configuration-Group is deployed back to the device.","width":160,"dataType":"string"},{"title":"Device Status","property":"configStatusMessage","display":"syncDiffChecker","visible":true,"minWidth":150,"dataType":"string"},{"title":"System IP","property":"system-ip","hideable":false,"width":120,"dataType":"ipv4"},{"title":"Certificate Serial","property":"serialNumber","width":150,"dataType":"string"},{"title":"Scheduled renewal date","property":"certScheduledDate","width":100,"dataType":"string"},{"title":"Certificate Expiration Date","property":"expirationDate","width":100,"dataType":"string"},{"title":"UUID","property":"uuid","width":270,"dataType":"string"}],"fields":[{"property":"certInstallStatus","dataType":"string","display":"iconAndToolTip"},{"property":"state","dataType":"string"},{"property":"deviceType","dataType":"string","display":"keyvalue"},{"property":"site-name","dataType":"string"},{"property":"host-name","dataType":"string"},{"property":"device-lock","dataType":"boolean"},{"property":"managed-by","dataType":"string"},{"property":"configStatusMessage","dataType":"string","display":"syncDiffChecker"},{"property":"system-ip","dataType":"ipv4"},{"property":"serialNumber","dataType":"string"},{"property":"certScheduledDate","dataType":"string"},{"property":"expirationDate","dataType":"string"},{"property":"uuid","dataType":"string"}],"viewKeys":{"uniqueKey":["chasisNumber"],"preferenceKey":"grid-certificateControllerDataList"},"modelNameMapping":{"vAnalytics":"Analytics","vSmart":"Controller","vManage":"Manager","Cloud OnRamp":"Cloud onRamp","vBond":"Validator"}},"data":[{"configuredSiteId":"9","configuredSystemIP":"10.0.9.1","deviceType":"vbond","serialNumber":"3924B97C98E06138F90130FD01DAC5AA0513AE18","ncsDeviceName":"vbond-2dadd49a-0283-427e-a4c8-f64268796d4f","configStatusMessage":"In Sync","templateApplyLog":["[7-Oct-2024 3:46:37 UTC] Sync-from successful"],"uuid":"2dadd49a-0283-427e-a4c8-f64268796d4f","managementSystemIP":"10.0.9.1","templateStatus":"Success","chasisNumber":"2dadd49a-0283-427e-a4c8-f64268796d4f","configStatusMessageDetails":"","configOperationMode":"cli","deviceModel":"vedge-cloud","deviceState":"READY","validity":"valid","platformFamily":"vedge-x86","hardwareVedge":false,"username":"--","rootCertHash":"4d910d5dfc928f8b562dfbad4415cdc8bc23b624","rsaKey4096Compatible":true,"state":"Installed","globalState":"normal","valid":"valid","requestTokenID":"a974fea8-802f-46a2-9ce8-67b5790ef58e","expirationDate":"Oct 05 03:34:34 2034 GMT","expirationDateLong":2043632074000,"deviceIP":"10.0.9.1","activity":["Installed"],"certInstallStatus":"Installed","personality":"vbond","expirationStatus":"normal","uploadSource":"Auto Discovered","timeRemainingForExpiration":315309023525,"solution":"common","site-id":"9","host-name":"vb1","system-ip":"10.0.9.1","vbond":"10.1.1.9","vmanageConnectionState":"connected","local-system-ip":"10.0.9.1","availableVersions":[],"defaultVersion":"20.17.999-3991","reachability":"reachable","version":"20.17.999-3991","uptime-date":1728272100000,"model_sku":"None","lastupdated":1728325410908,"vmanage-system-ip":"10.0.9.1","sp-organization-name":"Acme","organization-name":"Acme","certScheduledRenewal":"-1","certScheduledDate":"-1","lifeCycleRequired":true,"hardwareCertSerialNumber":"NA","subjectSerialNumber":"NA","resourceGroup":"global","id":"NA","tags":[],"draftMode":"Disabled","site-name":"SITE_9","device-lock":"No","managed-by":"Unmanaged"},{"configuredSiteId":"10","configuredSystemIP":"10.0.10.3","deviceType":"vmanage","serialNumber":"06B61E554850F7EA85991291D3D1640FE6E68F2A","ncsDeviceName":"vmanage-03d9aa5c-4899-4858-8ad3-24223d838066","configStatusMessage":"In Sync","templateApplyLog":["[7-Oct-2024 18:23:13 UTC] Sync-from successful"],"uuid":"03d9aa5c-4899-4858-8ad3-24223d838066","managementSystemIP":"10.0.10.3","templateStatus":"Success","chasisNumber":"03d9aa5c-4899-4858-8ad3-24223d838066","configStatusMessageDetails":"","configOperationMode":"cli","deviceModel":"vmanage","deviceState":"READY","validity":"valid","platformFamily":"vmanage","hardwareVedge":false,"username":"--","rootCertHash":"4d910d5dfc928f8b562dfbad4415cdc8bc23b624","rsaKey4096Compatible":true,"CSR":"vm","CSRDetail":"-----BEGIN CERTIFICATE REQUEST-----\nMIICpDCCAYwCAQAwXzELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMREwDwYDVQQH\nDAhTYW4gSm9zZTENMAsGA1UECwwEQWNtZTEUMBIGA1UECgwLdklQdGVsYSBJbmMx\nCzAJBgNVBAMMAnZtMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArTxK\noEBYTeKUJUioaJP+YqtIomwH0UMkObWOuk5g5B/2Kcp3xc75W+bJQZPymWTyYB3v\njQnNblUMElLGRlry/3FIPXLnVwO4uFnsNOxYZwO3VnaOwsUgwza8wezxwos6mqX2\nsPIIzNPES5CmjseJ2CIponJyh+xEUViBHK8Z+9zMO1uH8OtK1fnoHgeoJ7x2FC19\nqx5isu/SLEYmvOZ0Bn9u01nYuIoZHpW8mAQ18s1NLXI3w16tV90eWcU8IcqXoq0x\nXoskY+2qCVBsy/WFDfOhKzZQ//rJjNcaUy6uNKSOFwI9Ym8PWMUxDF698HuD7G8X\nf6ax79B0BLLuxp/qFQIDAQABoAAwDQYJKoZIhvcNAQELBQADggEBAGcqfifBc6HF\nqWNQy2piZvyapjaWltgkZm9BLcyKcFi9F9HEwlMrKibngnbGLJdSCSP29zQcAJ+x\n4ZcsLUM2vipf/3qIDFe8Y1VbcTrfPpyGz3k+uNgJOd3Y3kq46LCg5y88vOxfOU9s\nvZki3v0v4Aei6IqhE4jBQjXjX6T1dP8VFrFZtm7RlV8OCFzoSrO8KAr1mKH+LcMz\nFcDZ1Awb8mPzSa9W+wt+GfE9lVzK0uJHcMJ7mCfduXEBYLu5crxCuRbm7OlE124e\neURCz9mnlHxnYyd/nvVPb/0ViK50hcvOpRkL0nGVUuXJSR74TgY75t/XVJG2LvNw\n85Bplw5ktAs=\n-----END CERTIFICATE REQUEST-----","certificateDetail":"-----BEGIN CERTIFICATE-----\nMIIDRTCCAi0CFAa2HlVIUPfqhZkSkdPRZA/m5o8qMA0GCSqGSIb3DQEBCwUAMF8x\nCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJDQTERMA8GA1UEBwwIU2FuIEpvc2UxDTAL\nBgNVBAsMBEFjbWUxFDASBgNVBAoMC3ZJUHRlbGEgSW5jMQswCQYDVQQDDAJjYTAe\nFw0yNDEwMDcwMzM0MzRaFw0zNDEwMDUwMzM0MzRaMF8xCzAJBgNVBAYTAlVTMQsw\nCQYDVQQIDAJDQTERMA8GA1UEBwwIU2FuIEpvc2UxDTALBgNVBAsMBEFjbWUxFDAS\nBgNVBAoMC3ZJUHRlbGEgSW5jMQswCQYDVQQDDAJ2bTCCASIwDQYJKoZIhvcNAQEB\nBQADggEPADCCAQoCggEBAK08SqBAWE3ilCVIqGiT/mKrSKJsB9FDJDm1jrpOYOQf\n9inKd8XO+VvmyUGT8plk8mAd740JzW5VDBJSxkZa8v9xSD1y51cDuLhZ7DTsWGcD\nt1Z2jsLFIMM2vMHs8cKLOpql9rDyCMzTxEuQpo7HidgiKaJycofsRFFYgRyvGfvc\nzDtbh/DrStX56B4HqCe8dhQtfaseYrLv0ixGJrzmdAZ/btNZ2LiKGR6VvJgENfLN\nTS1yN8NerVfdHlnFPCHKl6KtMV6LJGPtqglQbMv1hQ3zoSs2UP/6yYzXGlMurjSk\njhcCPWJvD1jFMQxevfB7g+xvF3+mse/QdASy7saf6hUCAwEAATANBgkqhkiG9w0B\nAQsFAAOCAQEAHdmD6PKZdmxPvjXiaXf6n2j7VPKlP3AYVc/MZbi9QZml5f9hkmiE\nswueFrL6cXIuxc/f3hL7dgUR9hZgmiYmRIQPB5Y1oTVBvponDe1k6ScsdqHpEzTo\n0hRPGV9AQsKClfYiNOTXptrcNTNY5MnqW5oO4pwbSdoSM/iAupIgFFYQjBXQhb2x\n4QMx8BTU/eJDpt2pzXqQh1Rd1obBodFyJSg71QrWWuf3jCnV7FuZHDZOEl0b4OI3\nWz0iMdGwezhHqZtXv6p2lsUi2MInCe5Qi6TzfoNeyF5kks53iEBaJFZSmBH6RIbq\n5WonkNVwLXYF0CrR/x+Qk+h7bEYfABSy4g==\n-----END CERTIFICATE-----","state":"vBond Updated","globalState":"normal","valid":"valid","requestTokenID":"a50836c2-0f1e-4e98-a6cc-6876047b88ea","expirationDate":"Oct 05 03:34:34 2034 GMT","expirationDateLong":2043632074000,"deviceIP":"10.0.10.3","activity":["vBond Updated"],"certInstallStatus":"Installed","servicePersonality":"all","personality":"vmanage","expirationStatus":"normal","uploadSource":"Auto Discovered","timeRemainingForExpiration":315309023525,"solution":"common","site-id":"10","host-name":"vm","system-ip":"10.0.10.3","vbond":"vb.acme.local","vmanageConnectionState":"connected","local-system-ip":"10.0.10.3","availableVersions":[],"defaultVersion":"20.17.999-3991","reachability":"reachable","version":"20.17.999-3991","uptime-date":1728272040000,"model_sku":"None","lastupdated":1728325431653,"vmanage-system-ip":"10.0.10.3","domain-id":"0","sp-organization-name":"Acme","organization-name":"Acme","certScheduledRenewal":"-1","certScheduledDate":"-1","lifeCycleRequired":false,"hardwareCertSerialNumber":"NA","subjectSerialNumber":"NA","resourceGroup":"global","id":"NA","tags":[],"draftMode":"Disabled","site-name":"SITE_10","device-lock":"No","managed-by":"Unmanaged"},{"configuredSiteId":"9","configuredSystemIP":"10.0.9.2","deviceType":"vsmart","serialNumber":"3BA49C60C51FA260D3A10106258E7719E9B3446B","ncsDeviceName":"vsmart-5563d766-8e13-49f2-87d9-39e3bd7e2c98","configStatusMessage":"In Sync","templateApplyLog":["[7-Oct-2024 3:46:41 UTC] Sync-from successful"],"uuid":"5563d766-8e13-49f2-87d9-39e3bd7e2c98","managementSystemIP":"10.0.9.2","templateStatus":"Success","chasisNumber":"5563d766-8e13-49f2-87d9-39e3bd7e2c98","configStatusMessageDetails":"","configOperationMode":"cli","deviceModel":"vsmart","deviceState":"READY","validity":"valid","platformFamily":"vsmart","hardwareVedge":false,"username":"--","rootCertHash":"4d910d5dfc928f8b562dfbad4415cdc8bc23b624","rsaKey4096Compatible":true,"state":"vBond Updated","globalState":"normal","valid":"valid","requestTokenID":"9fe50252-9793-4961-859b-c830376fa12c","expirationDate":"Oct 05 03:34:34 2034 GMT","expirationDateLong":2043632074000,"deviceIP":"10.0.9.2","activity":["vBond Updated"],"certInstallStatus":"Installed","personality":"vsmart","expirationStatus":"normal","uploadSource":"Auto Discovered","timeRemainingForExpiration":315309023525,"region-id":[],"solution":"sdwan","site-id":"9","host-name":"vs1","system-ip":"10.0.9.2","vbond":"vb.acme.local","vmanageConnectionState":"connected","policy-template-name":"","policy-template-version":"","local-system-ip":"10.0.9.2","availableVersions":[],"defaultVersion":"20.17.999-3991","reachability":"reachable","version":"20.17.999-3991","uptime-date":1728272100000,"model_sku":"None","lastupdated":1728325439186,"vmanage-system-ip":"10.0.9.2","domain-id":"1","sp-organization-name":"Acme","organization-name":"Acme","certScheduledRenewal":"-1","certScheduledDate":"-1","lifeCycleRequired":false,"hardwareCertSerialNumber":"NA","subjectSerialNumber":"NA","resourceGroup":"global","id":"NA","tags":[],"draftMode":"Disabled","site-name":"SITE_9","device-lock":"No","managed-by":"Unmanaged"}]},"$$ref":"#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetcertcontrollerlistdataresponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"method":"get","path":"/certificate/data/controller/list"}}