{"type":"model","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/b95772dc6c621d9842faced8610ee58b0cb9cb02/5353f359-00fd-349d-ab9d-94968f26400d","info":{"title":"Service Health Probe Manager APIs","description":"Probe Manager related APIs for the Crosswork Service Health application.","termsOfService":"terms-of-service","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"},"version":"7.1.0"},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/ServiceHealth/aa_probemgr_overview.md"}},"openapi":"3.0.1","servers":[{"url":"/crosswork/probemgr/v1/"}],"securitySchemes":{"bearerAuth":{"type":"apiKey","description":"Security token for authorizing requests for these APIs.","name":"Authorization","in":"header"}}},"spec":{"type":"object","properties":{"serviceId":{"type":"string","description":"Service id"},"enableReactivate":{"description":"True if the probe re-activate button needs to be enabled in the UI","type":"boolean"},"status":{"type":"string","description":"Status of probe/endpoint/session","default":"PROBE_STATUS_UNKNOWN","enum":["PROBE_STATUS_UNKNOWN","PROBE_STATUS_PENDING","PROBE_STATUS_SUCCESS","PROBE_STATUS_ERROR"],"$$ref":"#/components/schemas/ProbeStatus"},"endpointStatus":{"description":"Detailed status of all endpoints","type":"array","items":{"type":"object","properties":{"id":{"description":"This is the key ID of the endpoint in the service configuration payload.","type":"string"},"vpnNeId":{"type":"string","description":"VPN Node ID"},"agentVLAN":{"type":"integer","description":"Agent VLAN","format":"int64"},"agentIPAddr":{"type":"string","description":"Agent IP Addr"},"interfaceName":{"type":"string","description":"Interface Name"},"status":{"type":"string","description":"Status of probe/endpoint/session","default":"PROBE_STATUS_UNKNOWN","enum":["PROBE_STATUS_UNKNOWN","PROBE_STATUS_PENDING","PROBE_STATUS_SUCCESS","PROBE_STATUS_ERROR"],"$$ref":"#/components/schemas/ProbeStatus"},"error":{"description":"Error message","type":"string"}},"description":"Probe endpoint status report.","$$ref":"#/components/schemas/ProbeEndpointStatus"}},"sessionStatus":{"description":"Detailed status of all sessions","type":"array","items":{"type":"object","properties":{"id":{"description":"Session ID. This is the UUID that the Probe Manager used to create the session in the Accedian server.","type":"string"},"sender":{"description":"Sender endpoint of the session. This is the key ID of the endpoint in the service configuration payload.","type":"string"},"reflector":{"description":"Reflector endpoint of the session. This is the key ID of the endpoint in the service configuration payload.","type":"string"},"status":{"type":"string","description":"Status of probe/endpoint/session","default":"PROBE_STATUS_UNKNOWN","enum":["PROBE_STATUS_UNKNOWN","PROBE_STATUS_PENDING","PROBE_STATUS_SUCCESS","PROBE_STATUS_ERROR"],"$$ref":"#/components/schemas/ProbeStatus"},"error":{"description":"Error message","type":"string"}},"description":"Probe session status report","$$ref":"#/components/schemas/ProbeSessionStatus"}},"error":{"description":"Error message","type":"string"}},"description":"Probe status response","$$ref":"#/components/schemas/ProbeStatusResponse","title":"ProbeStatusResponse"}}