Connectivity Check 3 min read
The Connectivity Check API is a small family of Ozone Connect endpoints implemented by your LFI. Ozone calls these endpoints from the API Hub to verify end-to-end connectivity, mutual TLS, and client-certificate propagation between the Hub and your Ozone Connect surface. The OpenAPI specification for these endpoints is published as Ozone Connect - Health Check APIs.
These endpoints MUST be implemented and reachable before your integration can proceed to testing — they are the first endpoints Ozone calls during onboarding connectivity validation. After onboarding, the API Hub does not call them automatically, but you MUST keep them in place so that connectivity issues can be debugged quickly.
The three Connectivity Check endpoints
| Endpoint | Purpose |
|---|---|
GET/hello | Basic connectivity check with no mTLS. Confirms network routing and that your Ozone Connect server is reachable from the Hub. Used early in onboarding, before mTLS is enforced — see After mTLS enforcement. |
GET/hello-mtls | Same as /hello but requires a valid client certificate. Confirms that mutual TLS is correctly terminated at your edge. |
GET/echo-cert | Returns the client certificate details your server received. Used to debug certificate propagation through reverse proxies and load balancers — useful when mTLS appears to succeed at the edge but the cert is stripped before reaching your application. |
During onboarding, then only on demand
- During onboarding. Before your integration can proceed to testing, Ozone runs end-to-end connectivity validation in both directions. On the LFI side, this means calling
/hello,/hello-mtls, and/echo-certon your Ozone Connect server. See Environment Specific — end-to-end validation. - On demand, to debug connectivity. After onboarding, Ozone calls these endpoints only when connectivity needs to be checked or debugged — for example after a transport certificate rotation, after a change to network routing, or while investigating a connectivity issue.
The API Hub does not call these endpoints automatically or on a schedule. They are diagnostic endpoints, not a health-monitoring feed.
Keep the endpoints in place; expect /hello to stop answering
Once connectivity has been established and verified, mTLS MUST be enforced across the whole Ozone Connect Base URL — see Security Validation. From then on, GET /hello no longer works as a check without mTLS: a request without a client certificate fails at the TLS handshake, like any other request to your Ozone Connect server.
GET /hello failing without a client certificate is the correct result once mTLS is enforced, not a defect. Do not exempt /hello from mTLS to keep it answering.
GET /hello-mtls and GET /echo-cert continue to work for the API Hub. You MUST keep all three endpoints in place after go-live. When a connectivity issue occurs, they let Ozone quickly isolate where it lies:
/hello-mtlsfails at the handshake: the problem is in your mTLS configuration, such as the trusted CA bundle, the server certificate, or the pin to the API Hub's C4 certificate./hello-mtlssucceeds but/echo-certreturns no certificate or the wrong one: the client certificate is being lost between the component that terminates TLS and your application.- Both succeed: transport and certificate propagation are working, so the problem lies elsewhere.
Where these endpoints sit on your Ozone Connect server
These endpoints sit on your Ozone Connect server alongside the Banking and Consent Events APIs. If you configure a path override for the Connectivity Check family during onboarding, the Hub calls OzoneConnectURL/<path>/<endpoint> — see Environment Specific — optional API family base paths.
