Send Docs Feedback

Add API Product to Key

Resource Summary

Security

Content Type

application/json, text/xml

Category

Developer App Keys,

updateKeyWithAPIProduct

POST

Add API Product to Key

Adds an API product to a developer app key, enabling the app that holds the key to access the API resources bundled in the API product. You can also use this API to add attributes to the key.


Use this API to add a new API product to an existing app. After adding the API product, you can use the same key to access all API products associated with the app.


You can use this API to add:

  • Products, by omitting any attributes
  • Attributes, by omitting any products
  • Both products and attributes

Resource URL

https://api.enterprise.apigee.com/v1 /organizations/{org_name}/developers/{developer_email_or_id}/apps/{app_name}/keys/{consumer_key}

Header Parameters

Name Values Description
Content-Type
(required)

Specify the Content-Type as application/json or text/xml.

Request Body

Name Description Default Required?
apiProducts The name of the API product to added to the developer app key. The name of the API product is the name returned by a GET request to the "List API Products" endpoint. For example, if the Display Name of the API product in the Edge UI is 'Premium API Product', then the name is 'premium-api-product' (all lowercase with spaces replaced by hyphens).   Yes
attributes Arbitrary name/value attributes added to the profile for the developer app key, usually used for app specific processing or metadata/analytics   No

org_name Mention the organization name true

developer_email_or_id Mention the developer email or ID true

app_name Mention the app name true

consumer_key Mention the consumer key 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?