Configure health endpoints

Save PDF

Last UpdatedSep 25, 2025
2 minute read

To monitor the status of Edge Data Store (EDS (Edge Data Store)), configure health information egress for its components to an Open Message Format (OMF (Open Message Format)) endpoint capable of receiving health messages. Health data is transmitted at a one minute interval.

Configure system health endpoints

To configure system health endpoints:

Using any text editor, create a JSON (JavaScript Object Notation) file containing system health endpoints.
Update the parameters as needed.
Save the file with the name System_HealthEndpoints.json.
Use any tool capable of making HTTP (Hypertext Transfer Protocol) requests to execute a POST command with the contents of that file to the following endpoint: http://localhost:5590/api/v1/configuration/System/HealthEndpoints, updating the port number if needed.

Definition: The POST method is used to create new resources.

Examples using cURL (Client for URL) and EdgeCmd utility (run this command from the same directory where the file is located):

curl -d "@System_HealthEndpoints.json" -H "Content-Type: application/json" http://localhost:5590/api/v1/configuration/System/HealthEndpoints

edgecmd set HealthEndpoints -file System_HealthEndpoints.json

Parameters

The following parameters are available for configuring system health endpoints.

Note: Parameters Buffering and MaxBufferSizeMb have been removed from the JSON (JavaScript Object Notation). Configure buffering at Buffering configuration.

Parameter	Required	Type	Nullable	Description
ClientId	Optional	string	Yes	The ID of the client used for authentication to CONNECT data services.
ClientSecret	Optional	string	Yes	The client secret used for authentication to CONNECT data services.
Endpoint	Required	string	Yes	The URL of the ingress point which accepts OMF (Open Message Format) health messages.
Id	Optional	string	Yes	The Id of the health endpoint configuration. The Id can be any alphanumeric string; for example, Endpoint1. If you do not specify an Id, EDS (Edge Data Store) generates one automatically.
Password	Optional	string	Yes	The password used for authentication to PI Web API OMF (Open Message Format) endpoint
UserName	Optional	string	Yes	The user name used for authentication to PI Web API OMF (Open Message Format) endpoint
TokenEndpoint	Optional	string	Yes	Retrieves an CONNECT data services token from an alternative endpoint. Allowed values are well-formed http or https endpoint string. Default value: null.
ValidateEndpointCertificate	Optional	Boolean	No	The AVEVA Adapter validates the endpoint certificate if set to true (recommended). If set to false, the AVEVA Adapter accepts any endpoint certificate. AVEVA strongly recommends using disabled endpoint certificate validation for testing purposes only.
EnableDiagnostics	Optional	Boolean	No	Determines if diagnostics are enabled

System health endpoints example

[

{

"endpoint": "https://<pi web api server>/piwebapi/omf/",

"UserName": "<username>",

"Password": "<password>"

{

"Endpoint": "https://<CONNECT data services OMF endpoint>",

"ClientId": "<clientid>",

"ClientSecret": "<clientsecret>"

}

]

Edge Data Store