Send Docs Feedback

Making management API calls from this page

  1. In the URL, replace any values indicated by "{ }", such as your organization name.
  2. Set the Basic Authentication credentials: Edge email and password (user must be in the Org Admin role).
    If you don't have an Apigee account,
    go here.
  3. Tweak the parameters and request body as needed.
  4. Send the live request to Edge!

Create API Product

Resource Summary

Security

Content Type

application/json, text/xml

Category

API Product,

createApiProduct

POST

Create API Product

Creates an API product in an organization.

You create API products after you have proxied backend services using API proxies.

An API product is a collection of API resources combined with quota settings and metadata that you can use to deliver customized and productized API bundles to your developer community. This metadata may include scope, environments, API proxies, and an extensible profile.

API products enable you repackage APIs on-the-fly, without having to do any additional coding or configuration.

We recommend that you start with a simple API product including only required elements. You then provision credentials to apps to enable them to start testing your APIs.

Once you have authentication and authorization working against a simple API product, you can iterate to create finer-grained API products, defining different sets of API resources for each API product.

For information about the request attributes that you can specify with this API, see Creating API products.

See also What is an API product?

CPS: With Core Persistence Services, the custom attribute limit is 20.

Resource URL

https://api.enterprise.apigee.com/v1 /organizations/{org_name}/apiproducts

Header Parameters

Name Values Description
Content-Type
(required)

Specify the content type as application/json or text/xml.

Request Body

Name Description Default Required?
approvalType manual or auto. If manual, consumer key is generated and returned in 'pending' state. If auto consumer key generated and returned in 'Approved' state. N/A Yes
attributes Arbitrary name/value pairs. Use this property to specify the access level of the API product as either public, private, or internal. Only products marked public are available to developers in the Apigee developer portal. For example, you can set a product to internal while it's in development and then change access to public when it's ready to release on the portal. API products marked as private do not appear on the portal but can be accessed by external developers. For example:

       "attributes": [
        {
          "name": "access",
          "value": "public"
        }
      ]
N/A No
description An overview of the API product. Include key information about the API product that is not captured by other fields. N/A No
displayName The name to be displayed in the UI or developer portal to developers registering for API access N/A Yes
name The internal name of the API Product. Characters you can use in the name are restricted to: A-Z0-9._\-$ %. N/A Yes
apiResources A comma separated list of API resources to be bundled in the API Product. See Creating API products for more on setting this value. N/A No
environments A comma-separated list of environment name in an organization. Requests to environments not listed are rejected. N/A No
proxies A comma-separated list of API proxy names in an organization. Requests to API proxies not listed are rejected. Api proxy names included here must already exist in the environment specified in the environment property because API Services validates proxy names when you create an API product. N/A Yes
quota The number of request messages permitted by this API product for the specified quotaInterval and quotaTimeUnit. For example, a quota of 50, for a quotaInterval of 12 and a quotaTimeUnit of hours means 50 requests are allowed every 12 hours. N/A Yes
quotaInterval The time interval over which the number of request messages is calculated. N/A Yes
quotaTimeUnit The time unit defined for the quotaInterval, as either: minute, hour, day, month. N/A Yes
scopes A comma separated list of scopes. These must map to the scopes defined in an Oauth policy associated with the API Product. Any scope mismatch between an Acces Token presented and the API Product results in auth failure. N/A No

org_name Mention the Organization name true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Working...

Help or comments?