Was this Helpful?

Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}

API Resource Path: /apis
API proxies that provide a facade for one or more backend services or APIs.

Apigee Edge exposes a RESTful API that enables you to create, import, deploy, and manage API proxies. To interact with API proxies you use the /apis URI.

An API proxy is a bundle of configuration files that act as a managed facade for existing HTTP services.

For usage, see Deploy API proxies using the management API.

For tools and sample API proxies, see Using the samples.

Create an API proxy Detail
/apis
Verb: POST
Description: Creates an API facade (and an API proxy configuration) on Apigee Edge.
Media types:
application/json
text/xml
Auth: Basic Auth
Delete an API Detail
/apis/{api_name}
Verb: DELETE
Description: Deletes an API and all associated endpoints, policies, resources, and revisions
Auth: Basic Auth
Delete an API proxy revision Detail
/apis/{api_name}/revisions/{revision_number}
Verb: DELETE
Description: Deletes a specific revision of an API
Auth: Basic Auth
Deploy an API proxy revision to an environment Detail
/environments/{env_name}/apis/{api_name}/revisions/{revision_number}/deployments
Verb: POST
Description: Deploys an API proxy to an environment (typically 'test' or 'prod') in an Apigee Edge orgaization.
Media types:
application/x-www-url-form-encoded
Auth: Basic Auth
Export an API proxy Detail
/apis/{api_name}/revisions/{revision_number}?format=bundle
Verb: GET
Description: Exports an API from Apigee Edge to the local machine a ZIP bundle of config and code files.
Media types:
application/octet-stream
Auth: Basic Auth
Get an API proxy Detail
/apis/{api_name}
Verb: GET
Description: Gets an API proxy by name, providing a list of existing revisions of the API proxy configuration.
Media types:
application/json
text/xml
Auth: Basic Auth
Import an API proxy Detail
/apis?action=import&name={api_name}
Verb: POST
Description: Uploads a ZIP-formatted API proxy configuration bundle from a local machine to an Apigee Edge organization.
Media types:
application/octet-stream
Auth: Basic Auth
List APIs Detail
/apis
Verb: GET
Description: Gets all APIs in an organization. The names in the list map to the names defined in the API proxy configuration for each API.
Media types:
application/json
text/xml
Auth: Basic Auth
Undeploy a revision of an API proxy from an environment Detail
/environments/{env_name}/apis/{api_name}/revisions/{revision_number}/deployments/
Verb: DELETE
Description: Undeploys an API proxy revision from an environment (typically 'test' or 'prod')
Media types:
application/octet-stream
Auth: Basic Auth
Update an API Detail
/apis/{api_name}
Verb: PUT
Description: Use the POST method to update a specific API proxy in an organization
Media types:
application/json
text/xml
Auth: Basic Auth

 

Help or comments?

  • Something's not working: See Apigee Support
  • Something's wrong with the docs: Click Send Feedback in the lower right.
    (Incorrect? Unclear? Broken link? Typo?)