>


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 https://docs.apigee.com.

Developer App Keys

Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}

API Resource Path: /developers/{developer_email}/apps/{app_name}/keys
Consumer credentials (also known as API keys or app keys) generated, provisioned, and managed by Apigee Edge for apps associated with individual developers.
Credential pairs consisting of consumer key and consumer secret provisioned by Apigee Edge to apps for specific API products. Apigee Edge maintains the relationship between consumer keys and API products, enabling API products to be added to and removed from consumer keys. A single consumer key can be used to access multiple API products. Keys may be manually or automatically approved for API products--how they are issued depends on the API product configuration. A key must approved and approved for an API product to be capable of accessing any of the URIs defined in the API product.
Create a consumer key and secret Detail 
/developers/{developer_email}/apps/{app_name}/keys/create
Verb: POST
Description: Creates a custom consumer key and secret for a developer app
Media types:
application/json
application/xml
Auth: Basic Auth
Add an API product to an app's key Detail 
/developers/{developer_email}/apps/{app_name}/keys/{consumer_key}
Verb: POST
Description: Adds an API product to a developer app key
Media types:
application/octet-stream
Auth: Basic Auth
Approve or revoke a developer app key Detail 
/developers/{developer_email}/apps/{app_name}/keys/{consumer_key}
Verb: POST
Description: Changes the status of a consumer key to 'revoked' or 'approved'
Media types:
application/octet-stream
Auth: Basic Auth
Approve or revoke API product for the key of a developer app Detail 
/developers/{developer_email}/apps/{app_name}/keys/{consumer_key}/apiproducts/{apiproduct_name}
Verb: POST
Description: Approves or revokes the association of a developer app's consumer key with an API product
Media types:
application/octet-stream
Auth: Basic Auth
Delete a developer app key Detail 
/developers/{developer_email}/apps/{app_name}/keys/{consumer_key}
Verb: DELETE
Description: Deletes a consumer key that belongs to an app.
Media types:
application/json
text/xml
Auth: Basic Auth
Remove an API product from a developer app key profile Detail 
/developers/{developer_email}/apps/{app_name}/keys/{consumer_key}/apiproducts/{apiproduct_name}
Verb: DELETE
Description: Removes an API product from a developer app key profile, and thereby renders the developer app unable to access the URIs defined in the API product.
Media types:
application/json
text/xml
Auth: Basic Auth
Get the consumer key for a developer app Detail 
/developers/{developer_email}/apps/{app_name}/keys/{consumer_key}
Verb: GET
Description: Returns details for a consumer key for a developer app
Media types:
application/json
text/xml
Auth: Basic Auth

 

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