getHealth

getHealth<ThrowOnError>(options?: Options<GetHealthData, ThrowOnError>): RequestResult<GetHealthResponses, GetHealthErrors, ThrowOnError>

Defined in: src/client/sdk.gen.ts:514

Health check

Returns the current health status of the service.

Type Parameters

Type Parameter	Default type
`ThrowOnError` extends `boolean`	`false`

Parameters

Parameter	Type
`options?`	`Options`<`GetHealthData`, `ThrowOnError`>

Returns

RequestResult<GetHealthResponses, GetHealthErrors, ThrowOnError>