Skip to main content

Class: HealthApi

clients/platform-client/src.HealthApi

HealthApi - object-oriented interface

Export​

Extends​

  • BaseAPI

Constructors​

new HealthApi(configuration, basePath, axios)​

new HealthApi(configuration?, basePath?, axios?): HealthApi

Parameters​

▪ configuration?: Configuration

▪ basePath?: string= BASE_PATH

▪ axios?: AxiosInstance= globalAxios

Returns​

HealthApi

Inherited from​

BaseAPI.constructor

Source​

libs/clients/platform-client/src/lib/generated/base.ts:53

Properties​

axios​

protected axios: AxiosInstance = globalAxios

Inherited from​

BaseAPI.axios

Source​

libs/clients/platform-client/src/lib/generated/base.ts:53


basePath​

protected basePath: string = BASE_PATH

Inherited from​

BaseAPI.basePath

Source​

libs/clients/platform-client/src/lib/generated/base.ts:53


configuration​

protected configuration: Configuration

Inherited from​

BaseAPI.configuration

Source​

libs/clients/platform-client/src/lib/generated/base.ts:51

Methods​

healthControllerGetHealth​

healthControllerGetHealth(options?): Promise<AxiosResponse<HealthControllerGetHealth200Response, any>>

Parameters​

▪ options?: AxiosRequestConfig<any>

Override http request option.

Returns​

Promise<AxiosResponse<HealthControllerGetHealth200Response, any>>

Throws​

Memberof​

HealthApi

Source​

libs/clients/platform-client/src/lib/generated/api.ts:1381


Generated using typedoc-plugin-markdown and TypeDoc