API Proxies API

Manage API proxies. You expose APIs on Apigee Edge by implementing API proxies. API proxies decouple the app-facing API from your backend services, shielding those apps from backend code changes. As you make backend changes to your services, apps continue to call the same API without any interruption. For more information, see Understanding APIs and API proxies.

Resource Types

URIs are relative to https://api.enterprise.apigee.com/v1, unless otherwise noted.

APIProxy

For more information, see APIProxy.
MethodEndpointDescription
get/organizations/{org_name}/apis/{api_name}

Gets an API proxy including a list of existing revisions.

APIProxyRequest

For more information, see APIProxyRequest.
MethodEndpointDescription
post/organizations/{org_name}/apis

Creates an API Proxy using one of the methods described below. The API proxy created will not be accessible at runtime until it is deployed to an environment.

  • Create an API proxy by setting the name field to the name of an API proxy in the request body. Typically, you then export the API proxy configuration bundle to your local machine for development, as described in Get an API proxy revision, and import the updated API proxy configuration bundle.

  • Import an API proxy configuration bundle stored as a zip file on your local machine to your organization on Edge by doing the following:

    • Set the action query parameter to import.
    • Set the Content-Type header to multipart/form-data.
    • Pass as a file the name of the API proxy configuration bundle stored in zip format on your local machine.

Note: Currently, you cannot import an API proxy configuration bundle using the Try this API pane.

For example, the following curl call imports an API proxy configuration bundle:

  -X POST \
  -H Content-Type="multipart/form-data"
  -F "file=@apiproxy.zip" \
  -u email:password 
  

When importing an API proxy:

  • If the API proxy does not exist, it will be created. If the API proxy exists, then a new revision is created.
  • To validate the API proxy configuration bundle before importing, set the validate query parameter to true.
  • To validate the API proxy configuration bundle only without importing it, set the action query parameter to validate. Invalid API proxy configurations are rejected, and a list of validation errors is returned to the client.

APIProxyRevision

For more information, see APIProxyRevision.
MethodEndpointDescription
post/organizations/{org_name}/apis

Creates an API Proxy using one of the methods described below. The API proxy created will not be accessible at runtime until it is deployed to an environment.

  • Create an API proxy by setting the name field to the name of an API proxy in the request body. Typically, you then export the API proxy configuration bundle to your local machine for development, as described in Get an API proxy revision, and import the updated API proxy configuration bundle.

  • Import an API proxy configuration bundle stored as a zip file on your local machine to your organization on Edge by doing the following:

    • Set the action query parameter to import.
    • Set the Content-Type header to multipart/form-data.
    • Pass as a file the name of the API proxy configuration bundle stored in zip format on your local machine.

Note: Currently, you cannot import an API proxy configuration bundle using the Try this API pane.

For example, the following curl call imports an API proxy configuration bundle:

  -X POST \
  -H Content-Type="multipart/form-data"
  -F "file=@apiproxy.zip" \
  -u email:password 
  

When importing an API proxy:

  • If the API proxy does not exist, it will be created. If the API proxy exists, then a new revision is created.
  • To validate the API proxy configuration bundle before importing, set the validate query parameter to true.
  • To validate the API proxy configuration bundle only without importing it, set the action query parameter to validate. Invalid API proxy configurations are rejected, and a list of validation errors is returned to the client.
delete/organizations/{org_name}/apis/{api_name}

Deletes an API proxy and all associated endpoints, policies, resources, and revisions. The API proxy must be undeployed before you can delete it.

delete/organizations/{org_name}/apis/{api_name}/revisions/{revision_number}

Deletes an API proxy revision and all policies, resources, endpoints, and revisions associated with it. The API proxy revision must be undeployed before you can delete it.

get/organizations/{org_name}/apis/{api_name}/revisions/{revision_number}

Gets or exports the API proxy revision.

To export the API proxy configuration for the specified revision as a zip file, set the format query parameter to bundle. If you are using curl, specify -o filename.zip to save the output to a file; otherwise, it displays to stdout. Then, develop the API proxy configuration locally and upload the updated API proxy configuration revision.