RSE API

IBM® Remote System Explorer API (RSE API) is a collection of REST APIs that allow a client to work with various components on the z/OS host system, including MVS data sets, z/OS UNIX files and commands, JES jobs, and more.

Use cases

  • Use RSE API by itself to interact with z/OS resources via REST API. For more information, see API Docs.

    To adopt this use case, install the RSE API host component by following its Program Directory, and configure the host component by following its Host Configuration Guide.

  • Use RSE API in combination with IBM RSE API Plug-in for Zowe CLI (on its own or as a part of Z Open Editor) to interact with z/OS resources from Zowe CLI or the Zowe Explorer VS Code extension.
    To adopt this use case, take the following actions:
    1. Install the RSE API host component by following its Program Directory, and configure the host component by following its Host Configuration Guide.
    2. Install the IBM RSE API Plug-in for Zowe CLI by following the procedure. For usage, see the IBM RSE API Plug-in for Zowe CLI tutorial.
  • Use RSE API in combination with Zowe API Mediation Layer.
    To adopt this use case, take the following actions:
    1. Install the RSE API host component by following its Program Directory, and configure the host component by following its Host Configuration Guide.
    2. Follow the instructions provided at the Using with Zowe API Mediation Layer section.

Prerequisites

RSE API has a dependency on z/OS® Explorer. Therefore, before you install and configure the RSE API host component, you must install and configure the z/OS Explorer host component by following the documents below: