Send Docs Feedback

Import a new API Proxy

Resource Summary

Security

Content Type

multipart/form-data

Category

API Proxy,

Api Transformation API Collection - student

POST

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

The example below generates a cURL command that specifies:

  • Content-Type as multipart/form-data
  • The ZIP file by using the cURL -F option 

However, you can also specify:

  • Content-Type as application/octet-stream
  • The ZIP file by using the cURL --data-binary option 

For example:

curl -X POST --data-binary @proxyZIP.zip -u "email:pWord" "https://api.enterprise.apigee.com/v1/o/myorg/apis?action=import&name=myapi" -H "Content-Type: appliation/octet-stream"

Resource URL

https://api.enterprise.apigee.com/v1 /organizations/{org_name}/apis

Query Parameters

Name Values Description
action
(required)

Available actions:

  • import - Imports the bundle
  • validate - Validates the bundle without importing it

name
(required)

Specify the API proxy name.

validate

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

Header Parameters

Name Values Description
Content-Type
(required)

Specify Content Type as multipart/form-data.

Attachments


Name Value Description
file
(required)

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

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Working...

Help or comments?