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.

Override conflict checks between revisions

When set to true, the override 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. You can pass the override value as a form or query parameter.

The following example sets the override value by passing it as a form parameter:

$ 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