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

API Resource Path: /developers/{developer_email}/apps/{app_name}/keys/{consumer_key}

Returns details for a consumer key for a developer app

Verb: GET

Auth: Basic Auth

Returns details for a consumer key, including the key and secret value, associated API products, and other metadata-

Sample Request:
$ curl https://api.enterprise.apigee.com/v1/o/{org_name}/developers/{developer_email}/apps/{app_name}/keys/{consumer_key} \ -u myname:mypass
Sample Response:
{
  "apiProducts" : [ {
    "apiproduct" : "FreeWeatherAPI",
    "status" : "approved"
  }, {
    "apiproduct" : "PremiumWeatherAPI",
    "status" : "approved"
  } ],
  "attributes" : [ {
    "name" : "region",
    "value" : "south"
  }, {
    "name" : "country",
    "value" : "norway"
  } ],
  "consumerKey" : "GGAjbeS9tZRwRgojDdbiHYln4EEU8K8i",
  "consumerSecret" : "pgppv4OsarzfwY2x",
  "status" : "approved"
}
Response Payload Elements:
Name Description
apiProducts Name of an API product associated with the key
status Status of the association with the API product
attributes Arbitrary name/value pairs associated with the key
consumerKey The value of the consumer key
consumerSecret The value of the secret associated with the consumer key
status Staus of the consumer key: 'approved' or 'pending'

Help or comments?

  • Something's not working: See Apigee Support
  • Something's wrong with the docs: Click Send Feedback in the lower right.
    (Incorrect? Unclear? Broken link? Typo?)