Function HealthApiFactory

  • HealthApi - factory interface

    Export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns {
        getHealth(options?) => AxiosPromise<HealthOutput>;
    }

    • getHealth:function
      • getHealth(options?): AxiosPromise<HealthOutput>

      • 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

        Parameters

        • Optional options: RawAxiosRequestConfig<any>

          Override http request option.

        Returns AxiosPromise<HealthOutput>

Settings

Member Visibility

Theme

Generated using TypeDoc