Class SystemApi

SystemApi - object-oriented interface

Export

SystemApi

Hierarchy

  • BaseAPI
    • SystemApi

Constructors

constructor

Properties

axios basePath configuration

Methods

getEndpointInfo getLogFile getPingSystem getPublicSystemInfo getServerLogs getSystemInfo getWakeOnLanInfo postPingSystem restartApplication shutdownApplication

Constructors

constructor

Properties

Protectedaxios

axios: AxiosInstance = globalAxios

ProtectedbasePath

basePath: string = BASE_PATH

Protectedconfiguration

configuration: undefined | Configuration

Methods

getEndpointInfo

  • getEndpointInfo(options?): Promise<AxiosResponse<EndPointInfo, any>>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<EndPointInfo, any>>

    Summary

    Gets information about the request endpoint.

    Throws

    Memberof

    SystemApi

getLogFile

  • getLogFile(requestParameters, options?): Promise<AxiosResponse<File, any>>

  • Parameters

    • requestParameters: SystemApiGetLogFileRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<File, any>>

    Summary

    Gets a log file.

    Throws

    Memberof

    SystemApi

getPingSystem

  • getPingSystem(options?): Promise<AxiosResponse<string, any>>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<string, any>>

    Summary

    Pings the system.

    Throws

    Memberof

    SystemApi

getPublicSystemInfo

getServerLogs

  • getServerLogs(options?): Promise<AxiosResponse<LogFile[], any>>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<LogFile[], any>>

    Summary

    Gets a list of available server log files.

    Throws

    Memberof

    SystemApi

getSystemInfo

  • getSystemInfo(options?): Promise<AxiosResponse<SystemInfo, any>>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<SystemInfo, any>>

    Summary

    Gets information about the server.

    Throws

    Memberof

    SystemApi

getWakeOnLanInfo

  • getWakeOnLanInfo(options?): Promise<AxiosResponse<WakeOnLanInfo[], any>>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<WakeOnLanInfo[], any>>

    Summary

    Gets wake on lan information.

    Deprecated

    Throws

    Memberof

    SystemApi

postPingSystem

  • postPingSystem(options?): Promise<AxiosResponse<string, any>>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<string, any>>

    Summary

    Pings the system.

    Throws

    Memberof

    SystemApi

restartApplication

  • restartApplication(options?): Promise<AxiosResponse<void, any>>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<void, any>>

    Summary

    Restarts the application.

    Throws

    Memberof

    SystemApi

shutdownApplication

  • shutdownApplication(options?): Promise<AxiosResponse<void, any>>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<void, any>>

    Summary

    Shuts down the application.

    Throws

    Memberof

    SystemApi

Settings

Member Visibility

On This Page

Constructors
Properties
Methods