Is this API to verify but not upload an API proxy bundle supported?

[sgilson]

There is an undocumented API that will validate an API bundle for an API proxy but not upload the bundle. It has the form:

curl -X POST -u uName:pWord -F "file=@proxyBundle.zip" "https://api.enterprise.apigee.com/v1/organizations/{orgName}/apis/{apiName}/revisions/1"

It does not create a new revision either, it just validates the bundle.

Is this a supported API that should be added to the doc?

Stephen

[sgilson · Accepted solution]

The API above actually does an import, so it is not the correct API to use to validate an API bundle.

The API to use is:

curl -v -X POST -u uName:pWord -F "file=@proxyBundle.zip" "https://api.enterprise.apigee.com/v1/organizations/{orgName}/apis?name={apiName}&action=validate" 

Thanks @arghya das.

Stephen

[#3]

Even maven plugin is using this API

[sgilson · Accepted solution]

The API above actually does an import, so it is not the correct API to use to validate an API bundle.

The API to use is:

curl -v -X POST -u uName:pWord -F "file=@proxyBundle.zip" "https://api.enterprise.apigee.com/v1/organizations/{orgName}/apis?name={apiName}&action=validate" 

Thanks @arghya das.

Stephen

[sgilson]

Doc updated here:

http://docs.apigee.com/management/apis/post/organizations/%7Borg_name%7D/apis-0

[#6]

@sgilson What about the API that you mentioned in the question? Can we document that as well?

That API is to update an activated revision.

[sgilson]

No - the recommendation is still to not doc or use that API.

[sgilson · Accepted solution]

After working with engineering, I have added the following API to the doc: Update API Proxy Revision.

Here is the description:

Uploads a ZIP-formatted API proxy configuration bundle from a local machine to an existing revision of an API proxy.

• If the API proxy revision is deployed, then undeploy the revision, update it, and then redeploy it.
• If the API proxy revision is undeployed, then only update the revision but do not deploy it.

Caution: Do not use this API if the API proxy is deployed in multiple environments. If the API is deployed in multiple environments, then use the Edge UI to update it.

Stephen