Method: organizations.developers.apps.keys.delete

Deletes an app's consumer key and removes all API products associated with the app. After the consumer key is deleted, it cannot be used to access any APIs.

Note: After you delete a consumer key, you may want to: 1. Create a new consumer key and secret for the developer app using the keys.create API, and subsequently add an API product to the key using the keys.updateDeveloperAppKey API. 2. Delete the developer app, if it is no longer required.

HTTP request

DELETE https://apigee.googleapis.com/v1/{name=organizations/*/developers/*/apps/*/keys/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Name of the developer app key. Use the following structure in your request: organizations/{org}/developers/{developerEmail}/apps/{app}/keys/{key}

Authorization requires the following IAM permission on the specified resource name:

  • apigee.appkeys.delete

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of DeveloperAppKey.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform