Send Docs Feedback

API reference getting started

Using the Edge management API

All Apigee Edge services can be configured through a RESTful API called the Edge management API. That means you can use scripts 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 progamatically, using any HTTP client. The API resources exposed by the Edge management API support JSON and XML, and are secured via HTTP Basic Authentication. You need to provide the email address and password associated with your organization on Apigee Edge with each API call that you make.

Following RESTful principles, you can call HTTP GET, POST, PUT, and DELETE methods on any of the API resources.

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 the Apigee Console.

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" ]
}'
https://api.enterprise.apigee.com/v1/o/my_org/apiproducts -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 the Apigee Console. The console provides a GUI for exploring an API's resources and executing its methods. The Console is pre-populated with information about the Edge management APIs that enables you to make a request to the API from your web browser. The Console also contains contextual links to the API Reference so that you can find out more information about each API as you try it out.

For more information about using the Edge management API, including information on using cURL, see Using the Apigee Edge development environment.

Authentication

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. 

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

About Core Persistence Services

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. For these customers, a property called features.isCpsEnabled is set on their organization. To view organization-level properties, run the following API call with organization administrator credentials:

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 type of note provides information specific to Core Persistence Services functionality.

 

Help or comments?