In November 2020, the Apigee Edge API reference documentation will move to a new experience based on the Apigee integrated portal and visitors to this site will be redirected.

You are viewing the Apigee Edge API reference documentation. For the main product docs, and to search all docs, go to

Note: If your Apigee account has multi-factor authentication (MFA) enabled, Basic Authentication will not work.

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.

Using the Edge management API

As an alternative to managing your Edge organization with the management UI, you can manage it using a RESTful API called the Edge management API. That means you can use the API to create, configure, and manage API proxies and API products, create and manage apps and app developers, and to perform many other types of operations programmatically, using any HTTP client. The API resources exposed by the Edge management API support JSON and XML, and are secured using HTTP Basic Authentication and OAuth.

Edge also supports Security Assertion Markup Language (SAML) 2.0 as the authentication mechanism. With SAML enabled, access to the Edge UI and Edge management API still uses OAuth2 access tokens. However, now you can generate these tokens from SAML assertions returned by an identity provider. 

You need to provide the email address and password associated with your organization on Apigee Edge with each API call that you make, and the user making the calls must be in a role that's allowed to make the calls, such as an Organization Administrator.

Following RESTful principles, you can call HTTP GET, POST, PUT, and DELETE methods on any of the API 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.

Getting started with the Edge management API

To get you started with the Edge management API, you don't need to write any code. Instead, you can use HTTP clients such as cURL or SmartDocs.

For example, the following cURL command executes an HTTP POST request to create an API product:

$ curl -H "Content-Type:application/json" -X POST -d
  "approvalType": "auto",
  "displayName": "Free API Product",
  "name": "weather_free",
  "proxies": [ "weatherapi" ],
  "environments": [ "test" ]
}' -u email:password

Every page of the API Reference contains an example cURL command that lets you try out the API.

Along with cURL, you can use SmartDocs. SmartDocs provide a GUI for exploring an API's resources and executing its methods.

For more information about using the Edge management API, including information on using cURL, see Developing with Apigee Edge.


In the previous cURL example, notice the required -u email:password. Your Apigee account includes a username and email, along with a password. While you can log into the Edge management UI with your username, you must make management API calls with your Apigee account email address. Your username will not work in management API calls.

You can also make calls to the management API using an OAuth token or SAML. For more information, see:


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

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:


  • JavaScript and Python scripting languages
  • Java programming language

You can also create API proxies in the Edge management UI. For a quick and easy tutorial, see Build your first API proxy.


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