This operation deploys an Apigee API proxy or Shared flow to Apigee by using the maven apigee deploy plugin. You must have built artifacts as zip file or expanded folder, see Extract and Save Artifacts workflow on FlexDeploy - Apigee Plugin Guide page under Example Workflows. See Special Considerations below for details on folder structure. You can download zip file from Apigee and commit to SCM for use during build, or you can commit zip file in expanded format.

The plugin unzips any zipped file within the artifacts and will search for the API proxy or Shared flow folder and deploy it to Apigee. This operation automatically generated pom.xml and parent-pom.xml necessary to use with Maven for deployment.

Environment/Instance Properties

Property Name	Property Code	Required	Description
Apigee Org Name	FDAPG_ORG	Yes	The org name of the Apigee account.
Apigee Username	FDAPG_USER	Yes	The username of the Apigee account.
Apigee Password	FDAPG_PASSWORD	Yes	The password of the Apigee account.
Apigee Environment Name	FDAGP_ENV	Yes	The environment name which the proxy or shared flow will be deployed to.
Apigee Host URL	FDAPG_HOST_URL	Yes	The host URL of the Apigee proxy. If the user is not using a private server the value should be https://api.enterprise.apigee.com
Apigee Deploy Option	FDAPG_DEPLOY_OPTION	Yes	The option to indicate how proxy or shared flow revision will be managed during deployment.

Project Properties

Property Name	Property Code	Required	Description
Apigee Proxy/Shared Flow Name	FDAPG_NAME	Yes	The name of the proxy or shared flow that will be deployed. This property is defaulted to the project name. This property is case sensitive and must be the exact same as the name of the API Proxy on Apigee.
API Type	FDAPG_API_TYPE	Yes	The type of the API, either API Proxy or Shared Flow.

Inputs

Input Name	Input Code	Required	Description

Outputs

Output Name	Description

Artifacts

This operation consumes artifacts from the artifacts repository.

Endpoint Selection

This operation does not require any specific external libraries or tools, hence you can add any endpoint to environment/instance configuration. We recommend use of LOCALHOST endpoint for simplicity. This operation will select all endpoints associated to the environment/instance.

Endpoint Execution

This operation will execute on any one of the selected endpoints and will be random in the determination of which one.

Special Considerations

The artifacts folder must contain Apigee bundle that has a maven compatible file structure. Below you can see the recommended folder structure for the project if it is an API proxy.

API Proxy Folder Structure

      |-gateway/ ***
        |-test-app/
          |-apiproxy/
            |-proxies
            |-resources/
              |-py
            |-policies
            |-targets

Below you can see the recommended folder structure for the project if it is a shared flow.

Shared Flow Folder Structure

	  |-gateway/ ***
        |-test-app/
          |-apiproxy/
            |-proxies
            |-resources/
              |-py
            |-policies
            |-targets

FlexDeploy 5.0.0

apigeeDeploy