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

Import a new API Proxy

Resource Summary

Security

Content Type

multipart/form-data

Category

API Proxy,

importNewApiProxy

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

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

curl -X POST -u email:password -F "file=@apiproxy.zip" "https://api.enterprise.apigee.com/v1/organizations/{org-name}/apis?action=import&name=example"

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

To validate the structure of the API proxy definition, enter true or exclude this query parameter. To bypass validation, enter false.

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?

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