Health endpoint parameters

Id

Optional

string

A unique identifier for the endpoint configuration

Allowed value: any string identifier Default value: new GUID

Endpoint

Required

string

The URL of a destination that accepts OMF v1.2 messages. Supported destinations include CONNECT data services.

Allowed value: well- formed http or https endpoint string

Default value: null

Username

Optional

string

The username used for Basic authentication to the PI Web API OMF endpoint.

PI server: Allowed value: any string Default: null

Password

Optional

string

The password used for Basic authentication to the PI Web API OMF endpoint.

PI server: Allowed value: any string or {{<secretId>}}

Default value: null

ClientId

Required for CONNECT data services endpoint

string

The client Id used for Bearer authentication to CONNECT data services endpoint

Allowed value: any string

Default value: null

ClientSecret

Required for CONNECT data services endpoint

string

The clientSecret used for Bearer authentication to CONNECT data services endpoint

Allowed value: any string or {{<secretId>}}

Default value: null

DebugExpiration

Optional

string

An optional string that enables logging of detailed information to disk for each outbound HTTP request pertaining to the egress endpoint. The value represents the date and time this detailed information should stop being saved.

Examples of valid strings representing date and time: UTC: yyyy-mm- ddThh:mm:ssZ, Local: yyyy-mm- ddThh:mm:ss. For more information, see Troubleshooting.

Default value: null

TokenEndpoint

Optional

string

An optional token endpoint where the agent retrieves a bearer token. When null or not specified the agent uses a well-known Open ID URL to retrieve it

Allowed value: well- formed http or https endpoint string

Default value: null

ValidateEndpointCertifica te

Optional

boolean

An optional Boolean flag where, when set to false, the agent will disable the verification of the server certificate

Note: AVEVA strongly recommends only disabling server certificate validation for testing purposes

Allowed value: true or false

Default value: true