You are viewing the Apigee Management API reference documentation. For the main product docs, and to search all docs, go to https://docs.apigee.com.

Deploy API Proxy

Resource Summary

Security

Content Type

application/x-www-form-urlencoded

Category

API Proxy,

deployAPIProxyPost

POST

Deploy API Proxy

Deploys a revision of an existing API proxy to an environment in an organization. API proxies cannot be invoked until they have been deployed to an environment. No body is required for this API call, because this simply executes a deploy command for an undeployed API proxy revision that already exists in your Edge organization.

If you experience HTTP 500 errors during API proxy deployment, see Seamless deployment (zero downtime) for information on using the override and delay parameters. That topic also has more details on API proxy deployment.

 

About API proxies that use shared flows

Edge does not validate the dependencies between shared flows and API proxies at deploy time. For example, if the Flow Callout policy in an API proxy references a shared flow that either doesn't exist or isn't deployed, API proxy deployment still succeeds. When Edge checks the dependency at runtime and validation fails, Edge throws an API proxy error with a 500 HTTP status code.

 

Pass override as a form parameter

When set to true, the override form parameter forces deployment of the new revision by overriding conflict checks between revisions. Set this parameter to true when using the delay parameter to minimize impact on in-flight transaction during deployment. 

 

For example:

$ curl -X POST -H "Content-type:application/x-www-form-urlencoded" \
  https://api.enterprise.apigee.com/v1/o/org_name/e/env_name/apis/name/revisions/number/deployments?delay=30 \
  -d "override=true" \
  -u email:password

Resource URL

https://api.enterprise.apigee.com/v1 /organizations/{org_name}/environments/{env_name}/apis/{api_name}/revisions/{revision_number}/deployments

Query Parameters

Name Values Description
delay

Enforces a delay, measured in seconds, before the currently deployed API proxy revision is undeployed and replaced by the new revision that is being deployed. Use this setting to minimize the impact of deployment on in-flight transactions. The default value is 0.

override

Flag that specifies whether to use seamless deployment to ensure zero downtime. Set this flag to "true" to instruct Edge to deploy the new revision fully before undeploying the existing revision. Use in conjunction with the delay parameter to control when the existing revision is undeployed.

Header Parameters

Name Values Description
Content-Type
(required)

Specify the Content Type.

Request Body

org_name Mention the organization name true

env_name Mention the environment name true

api_name Mention the API Proxy name true

revision_number Mention the revision true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Working...

Help or comments?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click the "Send Feedback" button.
    (Incorrect? Unclear? Broken link? Typo?)