Function SystemApiFp

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

• getEndpointInfo:function

  • getEndpointInfo(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<EndPointInfo>)>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<EndPointInfo>)>

    Summary

    Gets information about the request endpoint.

    Throws

• getLogFile:function

  • getLogFile(name, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>

  • Parameters

    • name: string

      The name of the log file to get.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>

    Summary

    Gets a log file.

    Throws

• getPingSystem:function

  • getPingSystem(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>)>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>)>

    Summary

    Pings the system.

    Throws

• getPublicSystemInfo:function

  • getPublicSystemInfo(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSystemInfo>)>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSystemInfo>)>

    Summary

    Gets public information about the server.

    Throws

• getServerLogs:function

  • getServerLogs(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<LogFile[]>)>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<LogFile[]>)>

    Summary

    Gets a list of available server log files.

    Throws

• getSystemInfo:function

  • getSystemInfo(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SystemInfo>)>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SystemInfo>)>

    Summary

    Gets information about the server.

    Throws

• getWakeOnLanInfo:function

  • getWakeOnLanInfo(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<WakeOnLanInfo[]>)>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<WakeOnLanInfo[]>)>

    Summary

    Gets wake on lan information.

    Deprecated

    Throws

• postPingSystem:function

  • postPingSystem(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>)>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>)>

    Summary

    Pings the system.

    Throws

• restartApplication:function

  • restartApplication(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Restarts the application.

    Throws

• shutdownApplication:function

  • shutdownApplication(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Shuts down the application.

    Throws