Class HealthApi

HealthApi - object-oriented interface

Export

Hierarchy

  • BaseAPI
    • HealthApi

Constructors

constructor

Properties

axios basePath configuration

Methods

getHealth

Constructors

constructor

  • Parameters

    • Optional configuration: Configuration
    • basePath: string = BASE_PATH
    • axios: AxiosInstance = globalAxios

    Returns HealthApi

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

getHealth

  • Retrieves the details of the API’s Health. Note: a 503 HTTP response code will be returned for the fail status.

    Summary

    Get the Overall Health of the API

    Throws

    Memberof

    HealthApi

    Parameters

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<HealthOutput, any>>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc