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.

Approve or Revoke Specific Key of Developer App

Resource Summary


Content Type



Developer App Keys,



Approve or Revoke Specific Key of Developer App

Set the status of an app's consumer key to 'approved' or 'revoked'.

You can approve a consumer key that is currently revoked or pending. Once approved, the app can use the consumer key to access APIs. You can also use this call to reapprove a revoked key.

Revoking a consumer key renders it unusable for the app to use to access an API.

Note the following:

  • Any access tokens associated with a revoked app key will remain active. However, Apigee Edge checks the status of the app key and if set to "revoked" it will not allow the call to go through.
  • 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}

Query Parameters

Name Values Description

Set the action to approve or revoke.

Header Parameters

Name Values Description

Specify Content-Type as application/octet-stream.

Request Body

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