Function SystemApiFactory

Returns {
    getEndpointInfo(options?: RawAxiosRequestConfig): AxiosPromise<EndPointInfo>;
    getLogFile(requestParameters: SystemApiGetLogFileRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
    getPingSystem(options?: RawAxiosRequestConfig): AxiosPromise<string>;
    getPublicSystemInfo(options?: RawAxiosRequestConfig): AxiosPromise<PublicSystemInfo>;
    getServerLogs(options?: RawAxiosRequestConfig): AxiosPromise<LogFile[]>;
    getSystemInfo(options?: RawAxiosRequestConfig): AxiosPromise<SystemInfo>;
    getWakeOnLanInfo(options?: RawAxiosRequestConfig): AxiosPromise<WakeOnLanInfo[]>;
    postPingSystem(options?: RawAxiosRequestConfig): AxiosPromise<string>;
    restartApplication(options?: RawAxiosRequestConfig): AxiosPromise<void>;
    shutdownApplication(options?: RawAxiosRequestConfig): AxiosPromise<void>;
}

• getEndpointInfo:function

  • getEndpointInfo(options?): AxiosPromise<EndPointInfo>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<EndPointInfo>

    Summary

    Gets information about the request endpoint.

    Throws

• getLogFile:function

  • getLogFile(requestParameters, options?): AxiosPromise<File>

  • Parameters

    • requestParameters: SystemApiGetLogFileRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<File>

    Summary

    Gets a log file.

    Throws

• getPingSystem:function

  • getPingSystem(options?): AxiosPromise<string>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<string>

    Summary

    Pings the system.

    Throws

• getPublicSystemInfo:function

  • getPublicSystemInfo(options?): AxiosPromise<PublicSystemInfo>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PublicSystemInfo>

    Summary

    Gets public information about the server.

    Throws

• getServerLogs:function

  • getServerLogs(options?): AxiosPromise<LogFile[]>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<LogFile[]>

    Summary

    Gets a list of available server log files.

    Throws

• getSystemInfo:function

  • getSystemInfo(options?): AxiosPromise<SystemInfo>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<SystemInfo>

    Summary

    Gets information about the server.

    Throws

• getWakeOnLanInfo:function

  • getWakeOnLanInfo(options?): AxiosPromise<WakeOnLanInfo[]>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<WakeOnLanInfo[]>

    Summary

    Gets wake on lan information.

    Deprecated

    Throws

• postPingSystem:function

  • postPingSystem(options?): AxiosPromise<string>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<string>

    Summary

    Pings the system.

    Throws

• restartApplication:function

  • restartApplication(options?): AxiosPromise<void>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Restarts the application.

    Throws

• shutdownApplication:function

  • shutdownApplication(options?): AxiosPromise<void>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Shuts down the application.

    Throws