tridion-sites-extensions-api-docs

Home > @tridion-sites/open-api-client > SystemService > healthCheck

SystemService.healthCheck() method

Checks and displays the health status of the API. This operation returns an instance of ‘ApiStatus’ type.

Signature:

static healthCheck(): CancelablePromise<ApiStatus>;

Returns:

CancelablePromise<ApiStatus>

ApiStatus The request was successful.

Exceptions

ApiError