Function SystemApiAxiosParamCreator

SystemApi - axios parameter creator

Export

  • SystemApiAxiosParamCreator(configuration?): {
        getEndpointInfo: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getLogFile: ((name: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getPingSystem: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getPublicSystemInfo: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getServerLogs: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getSystemInfo: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getWakeOnLanInfo: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        postPingSystem: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        restartApplication: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        shutdownApplication: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        getEndpointInfo: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getLogFile: ((name: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getPingSystem: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getPublicSystemInfo: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getServerLogs: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getSystemInfo: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getWakeOnLanInfo: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        postPingSystem: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        restartApplication: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        shutdownApplication: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • getEndpointInfo: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets information about the request endpoint.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getLogFile: ((name: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets a log file.

      Throws

        • (name, options?): Promise<RequestArgs>

        • Parameters

          • name: string

            The name of the log file to get.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getPingSystem: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Pings the system.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getPublicSystemInfo: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets public information about the server.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getServerLogs: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets a list of available server log files.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getSystemInfo: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets information about the server.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getWakeOnLanInfo: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets wake on lan information.

      Deprecated

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • postPingSystem: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Pings the system.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • restartApplication: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Restarts the application.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • shutdownApplication: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Shuts down the application.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility