Function SystemApiFactory

SystemApi - factory interface

Export

  • SystemApiFactory(
        configuration?: Configuration,
        basePath?: string,
        axios?: AxiosInstance,
    ): {
        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>;
    }

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    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
    • getLogFile:function
    • getPingSystem:function
      • getPingSystem(options?: RawAxiosRequestConfig): AxiosPromise<string>

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<string>

        Throws

    • getPublicSystemInfo:function
    • getServerLogs:function
    • getSystemInfo:function
    • getWakeOnLanInfo:function
    • postPingSystem:function
      • postPingSystem(options?: RawAxiosRequestConfig): AxiosPromise<string>

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<string>

        Throws

    • restartApplication:function
      • restartApplication(options?: RawAxiosRequestConfig): AxiosPromise<void>

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

    • shutdownApplication:function
      • shutdownApplication(options?: RawAxiosRequestConfig): AxiosPromise<void>

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

Settings

Member Visibility