System Automation Operations REST Server

This section describes the introduction, authentication, usage and troubleshooting tips of System Automation Operations REST Server.

Overview of Operations REST Server
The Operations REST Server component of IBM Z® System Automation provides an application programming interface (API) and allows the programmatic exploitation of resources that are automated by System Automation. Developers of other programs or products that allow to exploit REST interfaces can use this component to add System Automation operations as part of their workflow.
Documentation of Operations REST API
Usage of Operations REST API
You can access the System Automation Operations REST API by sending standard HTTPS requests to the configured port. Then the Operations REST API returns the response that contains a header and also a body for GET requests. The header contains a standard HTTPS return code and the body for GET requests contains a JSON data structure.
Migration from V1.0 to V1.1
If you want to update the System Automation Operations REST Server from V1.0 (shipped in OA59461) to V1.1 (shipped in OA61704), you can easily do so. No breaking changes were introduced with V1.1. You need to modify the configuration files. And if you want to use RACF key rings to manage certificate, you also need to make the configuration accordingly.
Securing and Authenticating Operations REST Server
After you install and configure the System Automation Operations REST Server by following "Step 28: Configure and Run the System Automation Operations REST server" in Planning and Installation, make the following necessary security and authentication settings.
Messages Generated by Operations REST Server in the System Log
Troubleshoot the Operations REST Server

Parent topic: Integrating with System Automation Operations REST API