Undeploying an API

When you undeploy an API, you remove it from the system and make it unavailable to users.

Before you begin

Follow these instructions to undeploy an API using the API Deployment utility.
  1. To issue the API Deployment utility commands, you must be a IBM® z/OS® Connect server administrator with access to the OMVS shell.
  2. You can also undeploy an API directly from the z/OS Connect API toolkit. In the z/OS Connect Servers view in the editor, right-click the API and select Stop API to stop the API first. Then right-click the API and select Remove API.


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


The API that is defined in the API archive file is undeployed. The directory with the name of the API is removed from the API deployment directory.

What to do next

Depending on the configuration of your server, you might need to restart the server for the changes to take effect.