You are viewing the Apigee Management API reference documentation. For the main product docs, and to search all docs, go to For cross-site search, click Search all in the search results.

Deploy API Proxy

Resource Summary


Content Type



API Proxy,



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.

Resource URL /organizations/{org_name}/environments/{env_name}/apis/{api_name}/revisions/{revision_number}/deployments

Query Parameters

Name Values Description

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.


When set to 'true', 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.

Header Parameters

Name Values Description

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



Make a request and see the response.

Make a request and see the response.

Make a request and see the response.


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?)