Automation Knowledge Base

REST API commands require software release 77 or higher

C_RESTCONTROL whattodo

Explanation

Controls REST API server. This command should be used with extra care as it can affect other users using the server.

Summary

set and get, value type: B

Parameters

whattodo: coded byte, what to do with the REST API server – START, STOP, RESTART

Example

C_RESTENABLE RESTART


C_RESTENABLE  userest

Explanation

Controls whether the chassis will run REST API server or not. The command takes affect only after chassis reset. To start/stop REST API server use C_RESTCONTROL command.

Summary

set and get, value type: B

Parameters

userest: coded byte, whether REST API server is enabled: OFF ON (default ON)

Example

C_RESTENABLE ON


C_RESTPORT tcpport

Explanation

The TCP port used by the REST API server.

Summary

Get only, value type: I

Parameters

tcpport: long, containing the TCP port number (default 57911)

Example

C_RESTPORT 57911


C_RESTSTATUS  status

Explanation

Obtains the REST API server operation status – whether it is active (running) or not. To get the admin status (whether the server is enabled or disabled) use C_RESTCONTROL command.

Summary

Get only, value type: B

Parameters

status: REST API server running status – SERVICE_ON or SERVICE_OFF

Example

C_RESTSTATUS SERVICE_ON