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

{"type":"api","title":"get vEdge 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 vEdge certificate data","description":"get vEdge certificate data","operationId":"getCertificateVedgeListData","parameters":[{"name":"model","in":"query","description":"Device Model","schema":{"type":"string"},"examples":{"Empty":{"description":"Empty"},"C8300-1N1S-4T2X":{"description":"C8300-1N1S-4T2X","value":"C8300-1N1S-4T2X"},"ASR1002-HX":{"description":"ASR1002-HX","value":"ASR1002-HX"},"C8000v":{"description":"C8000v","value":"C8000v"}}},{"name":"state","in":"query","description":"Certificate State","schema":{"type":"string"},"examples":{"CSR Failed":{"description":"CSR Failed","value":"csrfailed"},"Empty":{"description":"Empty"},"Certificate Installed":{"description":"Certificate Installed","value":"certinstalled"},"Token Generated":{"description":"Token Generated","value":"tokengenerated"},"Certificate Installation Failed":{"description":"Certificate Installation Failed","value":"certinstallfailed"},"Bootstrap Config Generated":{"description":"Bootstrap Config Generated","value":"bootstrapconfiggenerated"},"CSR Generated":{"description":"CSR Generated","value":"csrgenerated"},"Certificate serial number pushed to controllers":{"description":"Certificate serial number pushed to controllers","value":"certserialpushedtocontrollers"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Vedge Data Response":{"description":"Vedge Data Response","value":{"header":{"columns":[{"title":"State","property":"vedgeCertificateState","display":"iconAndToolTip","iconProperty":"vedgeCertificateState","toolTipProperty":"vedgeCertificateState","hideable":false,"icon":[{"key":"tokengenerated","value":"images/certStates/token-generated.png","displayKey":"Token Generated"},{"key":"bootstrapconfiggenerated","value":"images/certStates/bootstrap-config-generated.png","displayKey":"Bootstrap Configuration Generated"},{"key":"csrgenerated","value":"images/certStates/csr-generated.png","displayKey":"CSR Generated"},{"key":"csrfailed","value":"images/certStates/csr-failed.png","displayKey":"CSR Failed"},{"key":"certinstallfailed","value":"images/certStates/cert-install-failed.png","displayKey":"Certificate Installation Failed"},{"key":"certinstalled","value":"images/certStates/cert-installed.png","displayKey":"Certificate Installed"}],"width":40,"minWidth":40,"dataType":"string"},{"title":"Chassis Number","property":"chasisNumber","hideable":false,"width":270,"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":"Tags","property":"tags","display":"toggle","actionColumn":true,"visible":true,"minWidth":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":"Version","property":"version","visible":true,"width":150,"dataType":"string"},{"title":"Reachability","property":"reachability","hideable":true,"visible":true,"dataType":"string"},{"title":"Certificate Expiration Date","property":"expirationDate","width":100,"dataType":"string"},{"title":"Scheduled renewal date","property":"certScheduledDate","width":100,"dataType":"string"}],"fields":[{"property":"vedgeCertificateState","dataType":"string","display":"iconAndToolTip"},{"property":"chasisNumber","dataType":"string"},{"property":"site-name","dataType":"string"},{"property":"host-name","dataType":"string"},{"property":"tags","dataType":"string","display":"toggle"},{"property":"device-lock","dataType":"boolean"},{"property":"managed-by","dataType":"string"},{"property":"configStatusMessage","dataType":"string","display":"syncDiffChecker"},{"property":"version","dataType":"string"},{"property":"reachability","dataType":"string"},{"property":"expirationDate","dataType":"string"},{"property":"certScheduledDate","dataType":"string"}],"viewKeys":{"uniqueKey":["chasisNumber"],"preferenceKey":"grid-certificateVEdgeDataList"},"modelNameMapping":{"vAnalytics":"Analytics","vSmart":"Controller","vManage":"Manager","Cloud OnRamp":"Cloud onRamp","vBond":"Validator"}},"data":[{"configuredSiteId":"2","configuredSystemIP":"10.0.1.2","deviceType":"vedge","serialNumber":"79C44D216FF5988E98673D6F51F421A7D2034B79","ncsDeviceName":"vedge-C8K-ca3dbf94-f29c-415d-bf3a-4d803dc86f84","configStatusMessage":"In Sync","templateApplyLog":["[7-Oct-2024 3:46:52 UTC] Sync-from successful"],"uuid":"C8K-ca3dbf94-f29c-415d-bf3a-4d803dc86f84","managementSystemIP":"10.0.1.2","templateStatus":"Success","chasisNumber":"C8K-ca3dbf94-f29c-415d-bf3a-4d803dc86f84","configStatusMessageDetails":"","configOperationMode":"cli","deviceModel":"vedge-C8000V","deviceState":"READY","validity":"valid","platformFamily":"c8000v","hardwareVedge":false,"username":"--","rootCertHash":"4d910d5dfc928f8b562dfbad4415cdc8bc23b624","rsaKey4096Compatible":true,"deviceIP":"10.0.1.2","personality":"vedge","uploadSource":"Auto Discovered","region-id":[],"solution":"sdwan","site-id":"2","host-name":"ce1","system-ip":"10.0.1.2","vbond":"vb.acme.local","vmanageConnectionState":"connected","local-system-ip":"10.0.1.2","availableVersions":[],"defaultVersion":"17.17.01.0.209545","reachability":"reachable","version":"17.17.01.0.209545","uptime-date":1728272400000,"model_sku":"None","lastupdated":1728320117432,"vmanage-system-ip":"10.0.1.2","domain-id":"1","sp-organization-name":"Acme","organization-name":"Acme","certScheduledRenewal":"-1","certScheduledDate":"-1","lifeCycleRequired":true,"vedgeCertificateState":"certinstalled","expirationDate":"NA","hardwareCertSerialNumber":"NA","subjectSerialNumber":"NA","resourceGroup":"global","id":"NA","tags":[],"draftMode":"Disabled","site-name":"SITE_2","device-lock":"No","managed-by":"Unmanaged"},{"configuredSiteId":"1","configuredSystemIP":"10.0.1.1","deviceType":"vedge","serialNumber":"0ABF7384D3163E0A53768D374F4A8F22AA49EEF8","ncsDeviceName":"vedge-064f10fb-e795-45ed-9290-27f20b47a03b","configStatusMessage":"In Sync","templateApplyLog":["[7-Oct-2024 3:46:32 UTC] Sync-from successful"],"uuid":"064f10fb-e795-45ed-9290-27f20b47a03b","managementSystemIP":"10.0.1.1","templateStatus":"Success","chasisNumber":"064f10fb-e795-45ed-9290-27f20b47a03b","configStatusMessageDetails":"","configOperationMode":"cli","deviceModel":"vedge-cloud","deviceState":"READY","validity":"valid","platformFamily":"vedge-x86","hardwareVedge":false,"username":"--","rootCertHash":"4d910d5dfc928f8b562dfbad4415cdc8bc23b624","rsaKey4096Compatible":false,"deviceIP":"10.0.1.1","personality":"vedge","uploadSource":"Auto Discovered","region-id":[],"solution":"sdwan","site-id":"1","host-name":"ve1","system-ip":"10.0.1.1","vbond":"vb.acme.local","vmanageConnectionState":"connected","local-system-ip":"10.0.1.1","availableVersions":[],"defaultVersion":"20.9.6-862","reachability":"reachable","version":"20.9.6-862","uptime-date":1728272040000,"model_sku":"None","lastupdated":1728320114735,"vmanage-system-ip":"10.0.1.1","domain-id":"1","sp-organization-name":"Acme","organization-name":"Acme","certScheduledRenewal":"-1","certScheduledDate":"-1","lifeCycleRequired":true,"vedgeCertificateState":"certinstalled","expirationDate":"NA","hardwareCertSerialNumber":"NA","subjectSerialNumber":"NA","resourceGroup":"global","id":"NA","tags":[],"draftMode":"Disabled","site-name":"SITE_1","device-lock":"No","managed-by":"Unmanaged"}]},"$$ref":"#/components/examples/ComViptelaVmanageServerCertificateapiResponseExampleGetcertvedgelistdataresponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"method":"get","path":"/certificate/data/vedge/list"}}