Configure health endpoints

Save PDF

Last UpdatedFeb 04, 2025
3 minute read

You can configure AVEVA Adapters to produce and store health data at a designated health endpoint. You can use health data to ensure that your adapters are running properly and that data flows to the configured OMF endpoints.

A health endpoint designates an OMF endpoint where adapter health information is sent. You can configure multiple health endpoints.

Postman

To configure health endpoints using Postman:

To initialize the configuration, use the PUT method in conjunction with the http://localhost:5590/api/v1/configuration/system/healthendpoints REST endpoint.

Note: If you installed the adapter to listen on a non-default port, update 5590 to the port number in use.
Copy and paste an example configuration for endpoints into the Body section.

For sample JSONs, see the Examples section below.
Update the example JSON parameters for your environment.
Select Send to push the configuration to the adapter.

EdgeCmd

To configure health endpoints using EdgeCmd:

Using a text editor, create an empty text file.
Copy and paste an example configuration for health endpoints into the file.
Update the example JSON parameters for your environment.
Save the file. For example, ConfigureHealthEndpoints.json.
Open a command line session. Change directory to the location of your saved file.
Use the following edgecmd command with the name of your JSON file. For this example, we will use ConfigureHealthEndpoints.json for the saved file.

edgecmd -port <port number> -cid <ComponentID> set healthEndpoints -file /.ConfigureHealthEndpoints.json

For a list of other REST operations you can perform, like updating or replacing a health endpoints configuration, see the REST URLs section below.

Health endpoint parameters

The following parameters are available for configuring health endpoints:

Parameter	Required	Type	Description
id	Optional	string	Uniquely identifies the endpoint. This can be any alphanumeric string. If left blank, a unique value is generated automatically. Allowed value: any string identifier Default value: new GUID
endpoint	Required	string	The URL of the OMF endpoint to receive this health data. Allowed value: well-formed http or https endpoint string Default: null
username	Required for PI Web API endpoints	string	The username used to authenticate with a PI Web API OMF endpoint. Allowed value: any string Default: null
password	Required for PI Web API endpoints	string	The password used to authenticate with a PI Web API OMF endpoint. Allowed value: any string Default: null
clientId	Required for CONNECT data services endpoints	string	The client ID used for authentication with an CONNECT data services OMF endpoint. Allowed value: any string Default: null
clientSecret	Required for CONNECT data services endpoints	string	The client secret used for authentication with an CONNECT data services OMF endpoint. Allowed value: any string Default: null
tokenEndpoint	Optional for CONNECT data services endpoints	string	Retrieves an CONNECT data services token from an alternative endpoint. Allowed value: well-formed http or https endpoint string Default value: null
validateEndpointCertificate	Optional	boolean	Disables verification of destination security certificate. Use for testing only with self-signed certificates; AVEVA recommends keeping this set to the default (true) in production environments. Allowed value: true or false Default value: true

Examples

CONNECT data services endpoint

[

{

"id": "CONNECT data services",

"endpoint": "https://<OMF endpoint>",

"clientId": "<clientid>",

"clientSecret": "<clientsecret>"

}

]

PI Web API endpoint

[

{

"id": "PI Web API",

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

"username": "<username>",

"password": "<password>"

}

]

Note: When you use an adapter with a PI Web API health endpoint, the AF structure is required. If the elements are deleted, the adapter recreates the elements; if the account used to authenticate to the PI Web API has its permissions removed on the AF Server, the adapter retries sending health data to the PI Web API until the permissions are restored.

Edge Data Store endpoint

[

{

"id": "Edge Data Store",

"endpoint": "https://<Edge Data Store endpoint"

}

]

REST URLs

Relative URL	HTTP verb	Action
api/v1/configuration/system/healthEndpoints	GET	Gets all configured health endpoints
api/v1/configuration/system/healthEndpoints	DELETE	Deletes all configured health endpoints
api/v1/configuration/system/healthEndpoints	POST	Adds an array of health endpoints or a single endpoint. Fails if any endpoint already exists
api/v1/configuration/system/healthEndpoints	PUT	Replaces all health endpoints. Note: Requires an array of endpoints
api/v1/configuration/system/healthEndpoints	PATCH	Allows partial updating of configured health endpoints Note: The request must be an array containing one or more health endpoints. Each health endpoint in the array must include its Id.
api/v1/configuration/system/healthEndpoints/<Id>	GET	Gets configured health endpoint by Id
api/v1/configuration/system/healthEndpoints/<Id>	DELETE	Deletes configured health endpoint by Id
api/v1/configuration/system/healthEndpoints/<Id>	PUT	Updates or creates a new health endpoint with the specified Id
api/v1/configuration/system/healthEndpoints/<Id>	PATCH	Allows partial updating of configured health endpoint by Id

Note: Replace Id with the Id of the health endpoint.

AVEVA™ Adapter for Modbus TCP