Deploying an API

You must deploy an API to make it available to users.

Before you begin

  • To issue the API Deployment utility commands, you must be a IBM® z/OS® Connect server administrator with access to the OMVS shell.
  • You can also deploy an API directly from the z/OS Connect API toolkit. See instructions in Deploying an API in the API toolkit.
Follow these instructions to deploy an API using the API Deployment utility
  • The API archive file must already reside on a UNIX System Services file system on the same z/OS LPAR where IBM z/OS Connect is installed.
  • When transferring the API archive file to the file system, use binary mode.
  • After the API archive file is transferred, ensure that the owner of the file has read and write permission (a minimum of 644 by using the UNIX System Services chmod command).
  • You must be a IBM z/OS Connect server administrator to issue the API Deployment utility commands.
  • The API deployment directory must already exist. The user that issues the API Deployment utility must have the permission to write to the API deployment directory.
  • The apideploy command is a supplied z/OS UNIX command, so the administrator must have access to the OMVS shell to use the command.


  1. Go to the <installation_path>/bin directory.
  2. Issue the following command:
    apideploy -deploy -a <path_to_apiPackage.aar> -p <path_to_api_location>
    Specify the relative or absolute path to the API archive file (-a) and to the API deployment location (-p). For example:
    apideploy -deploy -a ./myApi/goodHealth.aar -p <WLP_USER_DIR>/servers/<serverName>/resources/zosconnect/apis


The API that is defined in the API archive file is saved to the IBM z/OS Connect server directory. A directory that is based on the API name is created in the API deployment directory.

What to do next

Depending on the configuration of your server, you might need to restart the server before the server is ready to process HTTP requests for the related IBM z/OS Connect services from a REST client.