Health Check v2

Available on Agent 2.0.0 and above. See the SBE x Agent compatibilities for more details about the minimal requirements.
Returns the connectivity status of your pod and key manager, as well as the Agent version.

Note: As of Symphony's 20.12 release to production environments, this endpoint is deprecated. This endpoint will be unsupported within three releases (approximately December 2021). Please check Health Check v3 for the new recommended alternative.

Results Fields

Field

Type

Description

podConnectivity

boolean

Indicates whether the Agent server can connect to the pod

podConnectivityError

string

Error details in case of no pod connectivity

keyManagerConnectivity

boolean

Indicates whether the Agent server can connect to the key manager

keyManagerConnectivityError

string

Error details in case of no key manager connectivity

encryptDecryptSuccess

boolean

Indicates whether the Agent can successfully decrypt and encrypt messages

encryptDecryptError

string

Error details in case of the encryption or decryption of the message fails

podVersion

string

The version number of the pod

agentVersion

string

The version number of the Agent server

agentServiceUser

boolean

Indicates whether agent service user is setup correctly.

agentServiceUserError

string

Error details in case agent service user is setup incorrectly.

ceServiceUser

boolean

Indicates whether CEService user is setup correctly.

ceServiceUserError

string

Error details in case CEService user is setup incorrectly.

Note: You need to pass the sessionToken and keyManagerToken on the headers, otherwise, agentservice tokens will be used.

Language