Method TestConnectionAsync

Namespace

Kepware.Api

Assembly

Kepware.Api.dll

TestConnectionAsync(CancellationToken)

Tests the connection to the Kepware server and checks if the server runtime is healthy. Also validates authentication credentials. Uses the /config/v1/status endpoint for health verification. Uses the /config/v1/doc endpoint to verify credentials.

public Task<bool> TestConnectionAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

Task<bool>

A task that represents the asynchronous operation. The task result contains a boolean indicating whether the connection was successful.