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.

Add API Product to Key

Resource Summary


Content Type

application/json, text/xml


Developer App Keys,



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 must include all existing attributes, whether or not you are updating them, as well as any new attributes that you are adding. 

Apigee recommends that you use the developer's email address when calling this API. Developer IDs are generated internally by Apigee and are not guaranteed to stay the same over time. 

Resource URL /organizations/{org_name}/developers/{developer_email_or_id}/apps/{app_name}/keys/{consumer_key}

Header Parameters

Name Values Description

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



Make a request and see the response.

Make a request and see the response.

Make a request and see the response.


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