Health endpoints

Save PDF

Last UpdatedJul 31, 2024
2 minute read

Configure health endpoints using Curl commands

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

Complete the following steps to configure health endpoints. Use the PUT method in conjunction with the http://localhost:5590/api/v1/configuration/system/healthendpoints REST endpoint to initialize the configuration.

Using a text editor, create an empty text file.
Copy and paste an example configuration for health endpoints into the file. For sample JSON, see Health endpoint examples.
Update the example JSON parameters for your environment. For a table of all available parameters, see Health endpoint parameters.
Save the file. For example, as ConfigureHealthEndpoints.json.
Open a command line session. Change directory to the location of ConfigureHealthEndpoints.json.
Enter the following curl command (which uses the PUT method) to initialize the health endpoint configuration.

curl.exe --ntlm --negotiate -u <UserName> -d "@ConfigureHealthEndpoints.json" -H "Content-Type: application/json" -X PUT "http://localhost:5590/api/v1/configuration/system/healthendpoints"

Notes:
If you installed the agent to listen on a non-default port, update 5590 to the port number in use.
For a list of other REST operations you can perform, like updating or replacing a health endpoints configuration, see Health endpoint REST URLs.

Configure health endpoints using the Configurator plugin

Health endpoints can be added, edited, or deleted in the Health tab.

The post-install configurator displaying the Events to CONNECT Health settings.

Create a new health endpoint

To add a health endpoint:

Select Add.
Enter values for the input fields.

For more information on the input fields, see the Health endpoint parameters.
Select Validate to verify the CONNECT data services OMF Health endpoint is valid and can be authenticated using the client credentials provided.

Modify a health endpoint

To edit a health endpoint:

Select the item in the Health Endpoint list.
Update the input fields.

Id will be read-only once it has been created.

Note: Client secret is not saved in the Configurator and must be entered again when editing the health endpoint.

Delete a health endpoint

To delete a health endpoint:

Select the item in the Health Endpoint list.
Select Delete.

AVEVA™ Events to CONNECT