Key Manager HealthCheck Monitoring

You can use the Key Manager (KM) healthcheck endpoint URLs to monitor the KM health and their connectivity/registration status with your Symphony Messaging pod environment. Replace <SYMPHONY-MESSAGING-POD-URL> with your actual Key Manager or POD URL depending on your setup.

KM endpoint URL #1

https://<SYMPHONY-MESSAGING-POD-URL>/keystore/HealthCheck/keymanagers

[
  {
    "osName": "Red Hat Enterprise Linux Server release 7.9 (Maipo)",
    "timeStamp": 1741705149504,
    "timedOut": false,
    "kmVersion": "***REDACTED***",
    "cryptoPack": "***REDACTED***",
    "hsmCheckSum": "***REDACTED***",
    "sha256KDFSupport": true,
    "report": "",
    "keyFingerPrints": {},
    "registered": true,
    "hostName": "***REDACTED***"
  },
  {
    "osName": "Red Hat Enterprise Linux Server release 7.8 (Maipo)",
    "timeStamp": 1741704979753,
    "timedOut": false,
    "kmVersion": "***REDACTED***",
    "cryptoPack": "***REDACTED***",
    "hsmCheckSum": "***REDACTED***",
    "sha256KDFSupport": true,
    "report": "",
    "keyFingerPrints": {},
    "registered": true,
    "hostName": "***REDACTED***"
  }
]

You can see in the response how many KMs are connected to the Pod and their details.

KM endpoint URL #2

https://<SYMPHONY-MESSAGING-POD-URL>/relay/HealthCheck

System is healthy: keymanager-768b809959-nlb2q KM Cloud logger configuration parameters: symphony.cloud.logging.enableRemote: null symphony.cloud.logging.cloudLoggerLevel: null cloudLogHarvesterURL: null

You can see if the KM is in a healthy state and connected to your Symphony Messaging pod in the response.