Class SystemApi

SystemApi - object-oriented interface

Export

SystemApi

Hierarchy

BaseAPI
- SystemApi

Index

Constructors

Properties

axios basePath configuration

Methods

getEndpointInfo getLogFile getPingSystem getPublicSystemInfo getServerLogs getSystemInfo getWakeOnLanInfo postPingSystem restartApplication shutdownApplication

Constructors

constructor

new SystemApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): SystemApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns SystemApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

getEndpointInfo

getEndpointInfo(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<EndPointInfo, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EndPointInfo, any>>
Throws
Memberof
SystemApi
- Defined in generated-client/api/system-api.ts:635

getLogFile

getLogFile(
requestParameters: SystemApiGetLogFileRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: SystemApiGetLogFileRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Throws
Memberof
SystemApi
- Defined in generated-client/api/system-api.ts:647

getPingSystem

getPingSystem(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<string, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<string, any>>
Throws
Memberof
SystemApi
- Defined in generated-client/api/system-api.ts:658

getPublicSystemInfo

getPublicSystemInfo(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PublicSystemInfo, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PublicSystemInfo, any>>
Throws
Memberof
SystemApi
- Defined in generated-client/api/system-api.ts:669

getServerLogs

getServerLogs(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<LogFile[], any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<LogFile[], any>>
Throws
Memberof
SystemApi
- Defined in generated-client/api/system-api.ts:680

getSystemInfo

getSystemInfo(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<SystemInfo, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SystemInfo, any>>
Throws
Memberof
SystemApi
- Defined in generated-client/api/system-api.ts:691

getWakeOnLanInfo

getWakeOnLanInfo(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<WakeOnLanInfo[], any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<WakeOnLanInfo[], any>>
Deprecated
Throws
Memberof
SystemApi
- Defined in generated-client/api/system-api.ts:703

postPingSystem

postPingSystem(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<string, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<string, any>>
Throws
Memberof
SystemApi
- Defined in generated-client/api/system-api.ts:714

restartApplication

restartApplication(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
SystemApi
- Defined in generated-client/api/system-api.ts:725

shutdownApplication

shutdownApplication(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
SystemApi
- Defined in generated-client/api/system-api.ts:736