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

Create a consumer key and secret

Resource Summary


Content Type

application/json, application/xml


Developer App Keys,



Create a consumer key and secret

Creates a custom consumer key and secret for a developer app. This is particularly useful if you want to migrate existing consumer keys/secrets to Edge from another system.

Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed.


Be aware of the following size limits on API keys. By staying within these limits, you help avoid service disruptions.


Consumer key (API key) size 2 KB
Consumer secret size 2 KB

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. 

After creating the consumer key and secret, associate the key with an API product, as described in Add API Product to Key.


If a consumer key and secret already exist, you can either keep them or delete them, as described in Delete Key for a Developer App.

In addition, you can use this API if you have existing API keys and secrets that you want to copy into Edge from another system. For more information, see Import existing consumer keys and secrets.


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

Header Parameters

Name Values Description

application/json or application/xml

Request Body

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