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.

About the Apigee management APIs

To view the available management APIs, use the left navigation bar or the API index page

Where to begin

You can get started calling the Apigee management API with the following helpful resources:

As noted in Best practices for API proxy design and development, do not call the Edge management API from inside API proxies. The management API is used for administrative management purposes only, not API flow logic. Use policies in API proxies instead.

Background information

While you don't need to be an expert in any of these topics to use the Edge management API, it's useful to have some familiarity with the following:

Optionally:

  • JavaScript and Python scripting languages
  • Java programming language

You can also create API proxies in the Edge management UI. For instructions, Build a simple API proxy.

Limits

See Management API limits for information on the number of calls per minute you are allowed to make.

About Core Persistence Services (CPS)

Like many of our customers, Apigee has embraced a microservices-based architecture, and this has improved the reliability and scalability of our products, as well as the way we develop and deliver them. As part of that effort, we're rolling out our next generation Core Persistence Services (CPS) in a limited fashion, and new customers will begin to use these new management APIs. Eventually, all customers will be on CPS. If your organization has CPS enabled, a property called features.isCpsEnabled is set on your org. To view organization-level properties, call the Get Organization API with your Apigee account credentials. Here's the cURL version:

curl -v 'https://api.enterprise.apigee.com/v1/organizations/{org_name}' -u you@email

The response for CPS-enabled organizations will contain the following:

{
  "name" : "features.isCpsEnabled",
  "value" : "true"
} 

The CPS microservices limited rollout is currently available to select new Edge cloud customers. Eventually, the new architecture will be used for all Edge cloud and Private Cloud customers.

In the meantime, we'll highlight CPS-specific information in the product documentation with the following icon:

CPS: This is an example of how content that is specific to Core Persistence Services (CPS) functionality will be presented in the documentation.

 

 

 

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