View Source

Class HealthCheckController

The API controller used to display the health check info and execute any actions

Inheritance

System.Object

UmbracoApiControllerBase

UmbracoApiController

UmbracoAuthorizedApiController

UmbracoAuthorizedJsonController

Namespace: Umbraco.Web.HealthCheck

Assembly: Umbraco.Web.dll

Syntax

public class HealthCheckController : UmbracoAuthorizedJsonController, IDiscoverable

Constructors

HealthCheckController(HealthCheckCollection, ILogger)

Declaration

public HealthCheckController(HealthCheckCollection checks, ILogger logger)

Parameters

Type	Name	Description
HealthCheckCollection	checks
ILogger	logger

Methods

ExecuteAction(HealthCheckAction)

Declaration

public HealthCheckStatus ExecuteAction(HealthCheckAction action)

Parameters

Type	Name	Description
HealthCheckAction	action

Returns

Type	Description
HealthCheckStatus

GetAllHealthChecks()

Gets a grouped list of health checks, but doesn't actively check the status of each health check.

Declaration

public object GetAllHealthChecks()

Returns

Type	Description
System.Object	Returns a collection of anonymous objects representing each group.

GetStatus(Guid)

Declaration

public object GetStatus(Guid id)

Parameters

Type	Name	Description
System.Guid	id

Returns

Type	Description
System.Object