system.md

System

system_controller = client.system

Class Name

SystemController

Methods

• Get Endpoint Info
• Get Log File
• Get Ping System
• Get Public System Info
• Get Server Logs
• Get System Info
• Get Wake on Lan Info
• Post Ping System
• Restart Application
• Shutdown Application

Get Endpoint Info

Gets information about the request endpoint.

def get_endpoint_info(self)

Response Type

EndPointInfo

Example Usage

result = system_controller.get_endpoint_info()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Log File

Gets a log file.

def get_log_file(self,
                name)

Parameters

Parameter	Type	Tags	Description
name	string	Query, Required	The name of the log file to get.

Response Type

binary

Example Usage

name = 'name0'

result = system_controller.get_log_file(name)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Ping System

Pings the system.

def get_ping_system(self)

Response Type

string

Example Usage

result = system_controller.get_ping_system()

Get Public System Info

Gets public information about the server.

def get_public_system_info(self)

Response Type

PublicSystemInfo

Example Usage

result = system_controller.get_public_system_info()

Get Server Logs

Gets a list of available server log files.

def get_server_logs(self)

Response Type

List of LogFile

Example Usage

result = system_controller.get_server_logs()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get System Info

Gets information about the server.

def get_system_info(self)

Response Type

SystemInfo

Example Usage

result = system_controller.get_system_info()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Wake on Lan Info

This endpoint is deprecated.

Gets wake on lan information.

def get_wake_on_lan_info(self)

Response Type

List of WakeOnLanInfo

Example Usage

result = system_controller.get_wake_on_lan_info()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Post Ping System

Pings the system.

def post_ping_system(self)

Response Type

string

Example Usage

result = system_controller.post_ping_system()

Restart Application

Restarts the application.

def restart_application(self)

Response Type

void

Example Usage

result = system_controller.restart_application()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Shutdown Application

Shuts down the application.

def shutdown_application(self)

Response Type

void

Example Usage

result = system_controller.shutdown_application()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException