Egress endpoint parameters

Id

Optional

string

Unique identifier for the endpoint.

Allowed value: any string identifier

Default value: new GUID

Endpoint

Required

string

Destination that accepts event messages. Supported destinations include CONNECT data services.

The value entered must comprise a well-formed HTTP or HTTPS endpoint string similar to the following: https://{%AvevaCONNECTdataservicesDomain%}/api/v1/Tenants/{%tenant ID%}/Namespaces/{%Namespace Guid%}

Allowed value: well-formed HTTP or HTTPS endpoint string

Default value: null

Notes:
Ensure that 'api/v1' is used in the URL of CONNECT data services.

Validate the Namespace Guid using the CONNECT data services API Console. To look up a guid using the console, in the URI field, append the /Namespaces path with a forward slash (/). The URI path automatically displays a list of available identifiers.



For more information on how to use the CONNECT data services API Console, refer to the CONNECT data services online help.

ClientId

Required

string

Authentication with the CONNECT data services endpoint.

Allowed value: any string, can be null if the endpoint URL schema is HTTP

Default value: null

Note: For more information on setting up AVEVA CONNECT clients, refer to the CONNECT data services online help.

ClientSecret

Required

string

Authentication with the CONNECT data services endpoint.

Allowed value: any string, can be null if the endpoint URL schema is HTTP

Default: null

TokenEndpoint

Optional

string

Retrieves a 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 certificate.

Note: Only use for testing with self-signed certificates.

Allowed value: true or false

Default value: true