Send Docs Feedback

Known issue: If this topic doesn't fully load, change the URL to http instead of https. Your actual API call will still securely use https.

Import a new API Proxy

Resource Summary


Content Type



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

In the following cURL example, Content-Type is automatically set to multipart/form-data

curl -X POST -u email:password -F "" "{org-name}/apis?action=import&name=example"

Resource URL /organizations/{org_name}/apis

Query Parameters

Name Values Description

Available actions:

  • import - Imports the bundle
  • validate - Validates the bundle without importing 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 as multipart/form-data.


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?