@umbraco-cms/backoffice
Preparing search index...
packages/core/backend-api
HealthCheckService
Class HealthCheckService
Index
Constructors
constructor
Methods
get
Health
Check
Group
get
Health
Check
Group
By
Name
post
Health
Check
Execute
Action
post
Health
Check
Group
By
Name
Check
Constructors
constructor
new
HealthCheckService
()
:
HealthCheckService
Returns
HealthCheckService
Methods
Static
get
Health
Check
Group
getHealthCheckGroup
<
ThrowOnError
extends
boolean
=
true
>
(
options
?:
Options
<
GetHealthCheckGroupData
,
ThrowOnError
>
,
)
:
RequestResult
<
GetHealthCheckGroupResponses
,
GetHealthCheckGroupErrors
,
ThrowOnError
,
"fields"
,
>
Type Parameters
ThrowOnError
extends
boolean
=
true
Parameters
Optional
options
:
Options
<
GetHealthCheckGroupData
,
ThrowOnError
>
Returns
RequestResult
<
GetHealthCheckGroupResponses
,
GetHealthCheckGroupErrors
,
ThrowOnError
,
"fields"
,
>
Static
get
Health
Check
Group
By
Name
getHealthCheckGroupByName
<
ThrowOnError
extends
boolean
=
true
>
(
options
:
Options
<
GetHealthCheckGroupByNameData
,
ThrowOnError
>
,
)
:
RequestResult
<
GetHealthCheckGroupByNameResponses
,
GetHealthCheckGroupByNameErrors
,
ThrowOnError
,
"fields"
,
>
Type Parameters
ThrowOnError
extends
boolean
=
true
Parameters
options
:
Options
<
GetHealthCheckGroupByNameData
,
ThrowOnError
>
Returns
RequestResult
<
GetHealthCheckGroupByNameResponses
,
GetHealthCheckGroupByNameErrors
,
ThrowOnError
,
"fields"
,
>
Static
post
Health
Check
Execute
Action
postHealthCheckExecuteAction
<
ThrowOnError
extends
boolean
=
true
>
(
options
?:
Options
<
PostHealthCheckExecuteActionData
,
ThrowOnError
>
,
)
:
RequestResult
<
PostHealthCheckExecuteActionResponses
,
PostHealthCheckExecuteActionErrors
,
ThrowOnError
,
"fields"
,
>
Type Parameters
ThrowOnError
extends
boolean
=
true
Parameters
Optional
options
:
Options
<
PostHealthCheckExecuteActionData
,
ThrowOnError
>
Returns
RequestResult
<
PostHealthCheckExecuteActionResponses
,
PostHealthCheckExecuteActionErrors
,
ThrowOnError
,
"fields"
,
>
Static
post
Health
Check
Group
By
Name
Check
postHealthCheckGroupByNameCheck
<
ThrowOnError
extends
boolean
=
true
>
(
options
:
Options
<
PostHealthCheckGroupByNameCheckData
,
ThrowOnError
>
,
)
:
RequestResult
<
PostHealthCheckGroupByNameCheckResponses
,
PostHealthCheckGroupByNameCheckErrors
,
ThrowOnError
,
"fields"
,
>
Type Parameters
ThrowOnError
extends
boolean
=
true
Parameters
options
:
Options
<
PostHealthCheckGroupByNameCheckData
,
ThrowOnError
>
Returns
RequestResult
<
PostHealthCheckGroupByNameCheckResponses
,
PostHealthCheckGroupByNameCheckErrors
,
ThrowOnError
,
"fields"
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
get
Health
Check
Group
get
Health
Check
Group
By
Name
post
Health
Check
Execute
Action
post
Health
Check
Group
By
Name
Check
@umbraco-cms/backoffice
Loading...