Server Automation REST API

The Server Automation REST API is a node-based application which enables you to execute and monitor Server Automation Plans. Using this REST API, you can perform Server Automation tasks in a standardized and operating system-independent method.

Note: An older version of this application based on IBM WAS Liberty profile is still available; however, new functionalities will be made available only on the Node-based application, and hence, the older version (fixlets 108 and 109 of SA REST API) will be phased out shortly.

The starting/stopping of this service is controlled by means of a Windows service called " SARESTService".

Note:

In fixlet (ID: 157), both http and https ports are configurable. Default http port is 8080 and https port is 8443. User needs to update the default http and https port before installation. If the computer already runs the legacy WAS Liberty based service, the user still can install the fixlet 157 on any available ports.

The application runs only on Windows computers.

How to install/uninstall the node-based Server Automation REST API

The Node-based REST API is installed/uninstalled by means of two tasks that can be found on the "Server Automation" site, namely:

(ID: 157) Deploy Server Automation REST API
(ID: 158) Remove Server Automation REST API

The server logs can be found at: <INSTALL ROOT>\sa_rest_node\Logs.

Note: Server Automation Rest API documentation is also available in Swagger UI compatible format at https://localhost:8443/serverautomation/api-docs/.

Fore more information, refer to Server Automation REST API

Configuration of server side Ciphers

Cipher mechanism is used to encrypt or decrypt messages in SA REST APIs. If you do not want to use the default ciphers, you can configure your custom cipher in the config.js file by configuring it. To add your cipher in the config.js file in a Windows system, perform the following steps:

Navigate to <INSTALL ROOT>\sa_rest_node\config.js, where SA REST API is installed.

Open the config.js file in a text editor. Sample content in config.js file looks as follows:

        exports.httpsport  = "<some value>";
        exports.ip  = "<some value>";
        exports.bigFixServerUrl = "<some value>";
        exports.sslKeyPath = "<some value>";
        exports.sslCertPath = "<some value>";
        exports.ciphers = "";

By default, the value of exports.ciphers is empty. You can add your ciphers within double quotes separated by commas.
Note: Do not modify any other existing information apart from adding Cipher, which might lead to unexpected errors.
Save and close the file.
Restart the SARESTService for the changes to take effect.