@jellyfin/sdk
    Preparing search index...

    Function SystemApiFactory

    • SystemApi - factory interface

      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
        • Parameters

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns AxiosPromise<string>

      • getPublicSystemInfo: function
      • getServerLogs: function
      • getSystemInfo: function
      • getWakeOnLanInfo: function
      • postPingSystem: function
        • Parameters

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns AxiosPromise<string>

      • restartApplication: function
        • Parameters

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns AxiosPromise<void>

      • shutdownApplication: function
        • Parameters

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns AxiosPromise<void>