API Platform Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}
API Resource Path: /developers/{developer_email}/apps/{app_name}
Updates the app to get a new set of consumer credentials.
Verb: PUT
Auth: Basic AuthUpdates and existing app profile with the information in the request payload.
Sample Request:$ curl -H "Content-type:application/json" -X PUT -d \
'{
"access_type" : "write",
"attributes" : [ {
"name" : "Language",
"value" : "C"
} ],
"apiProducts": [ "TestApiProduct"],
"callback_url" : "www.apigee.com",
"name" : "MyTestApp"
}' \
-u myname:mypass https://api.enterprise.apigee.com/v1/o/{myorg}/developers/{developerEmail}/apps/{appName}
Sample Response:
{
"accessType" : "write",
"attributes" : [ {
"name" : "Language",
"value" : "C"
} ],
"callbackUrl" : "www.apigee.com",
"createdAt" : 1343052353553,
"createdBy" : "Admin",
"credentials" : [ {
"apiProducts" : [ {
"apiproduct" : "TestApiProduct",
"status" : "pending"
} ],
"attributes" : [ ],
"consumerKey" : "pCmh8dfwcDF1m9IIIqbUY2hGDO3obYgU",
"consumerSecret" : "HRlGbgdHLEwvzBhQ",
"status" : "approved"
}, {
"apiProducts" : [ {
"apiproduct" : "TestApiProduct",
"status" : "pending"
} ],
"attributes" : [ ],
"consumerKey" : "VBsAd4wO0wkevxGaqlKlVF8qlGa4ydsT",
"consumerSecret" : "gi8yb1ZFZ7ztRhYa",
"status" : "approved"
} ],
"lastModifiedAt" : 1343052354468,
"lastModifiedBy" : "Admin",
"name" : "MyTestApp",
"status" : "approved"
}
Response Payload Elements:
| Name | Description |
|---|---|
| accessType | |
| attributes | Name/value pairs used to extend the default app profile |
| callbackUrl | A callback URL that can be used for app specific callbacks |
| createdAt | Unix time when the app was created |
| credentials | A list of associations between API products and consumer keys for the app |
| apiProducts | A list of API products with which the app is associated |
| apiproduct | The API product with which teh app is associated |
| status | Status of the app association with the API product: 'approved' or 'pending' |
| attributes | Name'value pairs used to extend the profile |
| consumerKey | The value of the consumer key associated with the API product |
| consumerSecret | Value of the consumer secret associated with the consumer key |
| status | Status of the consumer key: 'approved' or 'pending' |
| lastModifiedAt | Unix time when the app was last modified |
| lastModifiedBy | User name of the Apigee user who last modified the app |
| name | Name of the app |
| status | Status of the app: 'approved or 'unapproved' |