apideploy command syntax

Deploy or undeploy APIs

Syntax

apideploy -deploy -a <path to api archiveFile> -p <path to apiDeploy location> -w

apideploy -undeploy -a <path to api archiveFile> -p <path to apiDeploy location>

Parameters

-deploy: Specifies the API deployment task.
-undeploy: Specifies the API undeployment task.
-a: Specifies the relative or absolute path to the API archive file. The archive file has a file type of .aar. The path cannot include parentheses and soft links are not supported.
-p: Specifies the relative or absolute path to the API deployment location for the server. For example, <WLP_USER_DIR>/servers/<serverName>/resources/zosconnect/apis. The path cannot include parentheses and soft links are not supported.
-w: If specified, the API replaces the API, if it is already deployed, with the new version. The API identifier is the API name that is specified in the z/OS® Connect API toolkit when you create the API.

Examples

The following example deploys the API that is defined in the goodhealth.aar file by specifying an absolute path to the .aar file and an absolute path to the API deployment directory.

apideploy -deploy -a /usr/lpp/myAPIs/goodhealth.aar 
-p <WLP_USER_DIR>/servers/<serverName>/resources/zosconnect/apis

The following example redeploys an API by specifying the -w parameter:

apideploy -deploy -a /usr/lpp/myAPIs/goodhealth.aar 
-p <WLP_USER_DIR>/servers/<serverName>/resources/zosconnect/apis  -w

The following example undeploys the API that is defined in the goodhealth.aar file by specifying an absolute path to the .aar file and an absolute path to the API deployment directory.

apideploy -undeploy -a /usr/lpp/myAPIs/goodhealth.aar 
-p <WLP_USER_DIR>/servers/<serverName>/resources/zosconnect/apis