Send Docs Feedback

SmartDocs basics

1. In the Resource URL, replace any values enclosed in "{}", such as your organization name.
2. Set the Basic Authentication credentials. These are your Edge email and password (user must be in the Org Admin role).
3. Tweak the Request Body as needed (if a body is needed).
4. Send the live request to Edge and view the response! You can also view Request data.

Deploy API Proxy

Resource Summary

Auth Type


Content Type


API Proxy,



Deploy API Proxy

Deploys a revision of an API proxy to an environment in an organization. API proxies cannot be invoked until they have been deployed to an environment.

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

    Query Parameters

  • Name
  • 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.
  • override
    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.

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

Basic Auth

OAuth 2

Custom Token


Make a request and see the response.

Make a request and see the response.


Help or comments?