Marcus Andersson
a2d741f60f
* regenerated packages docs. * fixed spelling issues. * fixed spelling issues.
56 lines
1.2 KiB
Markdown
56 lines
1.2 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "HealthCheckResult"
|
|
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
|
type = "docs"
|
|
draft = true
|
|
+++
|
|
|
|
## HealthCheckResult interface
|
|
|
|
Describes the payload returned when checking the health of a data source plugin.
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface HealthCheckResult
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { HealthCheckResult } from '@grafana/runtime';
|
|
```
|
|
<b>Properties</b>
|
|
|
|
| Property | Type | Description |
|
|
| --- | --- | --- |
|
|
| [details](#details-property) | <code>Record<string, any></code> | |
|
|
| [message](#message-property) | <code>string</code> | |
|
|
| [status](#status-property) | <code>HealthStatus</code> | |
|
|
|
|
### details property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
details?: Record<string, any>;
|
|
```
|
|
|
|
### message property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
message: string;
|
|
```
|
|
|
|
### status property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
status: HealthStatus;
|
|
```
|