Send Docs Feedback

Import a new API Proxy

Resource Summary


Content Type

multipart/form-data, application/octet-stream


API Proxy,

Api Transformation API Collection - student


Import a new API Proxy

Uploads a ZIP-formatted API proxy configuration bundle from a local machine to an organization on Edge. If the API proxy already exists, then create a new revision of the API proxy. If the API proxy does not exist, then create it. 

Once imported, the API revision must be deployed before it can be accessed at runtime.

By default, API proxy configurations are not validated on import:

  • To validate the API proxy definition on import, set the validate query parameter to true. Invalid API proxy configurations are rejected, and a list of validation errors returned to the client.
  • To validate the API only but not import it, set the action query parameter to validate

Resource URL /organizations/{org_name}/apis

Query Parameters

Name Values Description

Set the action to import to import the bundle and to validate to validate it but not import it.


Specify the API proxy name.


Specify to validate, true, or not validate, false, the proxy definition.

Header Parameters

Name Values Description

Specify Content Type: either multipart/form-data or application/octet-stream


Name Value Description

Specify the ZIP file containing the API proxy configuration bundle.

Request Body

org_name Mention the organization name true

org_name Mention the organization name 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?