View
Apigee Edge documentation.
This section describes how to register apps and manage API keys.
The primary way to control who can access your APIs is through application registration.
As an API provider, you create one or more API products that bundle your APIs into service tiers. API products let you limit traffic and access levels at very granular levels. When you create an API product, you can set the access level to Public, Private, or Internal only. For more information, see Access level.
When registering an app, the app developer selects which API products to use and Apigee provides a single API key that the developer uses to access those API products. The app developer passes the API key in each call to the API proxies contained in the API products. At any time, you can revoke an app's API key, preventing an app developer from accessing all or a subset of API products referenced by that app.
App developers who have access to an API product through their membership in an AppGroup use similar methods as individual app developers to register their app, but as part of their AppGroup memberships.
Typically, app developers register to use your API products using your developer portal. The steps to build your portal and publish your API products are described in Build your portal.
You can have more control over the app registration process by registering your apps using the Apigee UI or Apigee API instead. For example, you may want to register apps for your internal development teams or for a developer that cannot access your portal.
The following sections describe how to register apps and manage API keys using the UI and API.
To view and register apps, and manage API keys in the Apigee UI you use the Apps view.
Go to the Distribution > Apps page in the Apigee in Cloud console:
The Apps view lets you do the following:
An app can be registered in the following ways:
Registered apps are added to the following:
To register an app in Apigee:
Go to the Distribution > Apps page:| Field | Description | Required? |
|---|---|---|
| Name | Name of the app. You can't change the name once the app is created. This name is used in Apigee API calls. | Required |
| Display Name | Display name for the app that appears in the Apigee UI and the developer portal. | Optional |
| Developer | Select a developer name from the drop-down. Note: For performance reasons, not all developers are displayed in the drop-down. Start typing the developer name or email in the search box, and the drop-down values are automatically refined to match the text you are typing. See also Register app developers. |
Required |
| Callback URL | Typically specifies the URL of an app that is designated to receive an authorization code on behalf of the client app. This value is not required for all API products. | Optional |
| Notes | Descriptive notes for the app. | Optional |
| Field | Description |
|---|---|
| Expiry | Select an expiration duration or date, or set the API key to never expire. |
| Products | Associate one or more API products with the API key:
|
Pending approval status.
Otherwise, it will show Approved. In this step, you can change the approval status.
If the API products you associated with the app required manual approval for their API keys, approve them, as described in Approving or revoking API keys.
To view apps registered for a specific developer, use one of the following methods:
To view and edit an app:
Go to the Distribution > Apps page: Go to Apps Click anywhere in the row of the app that you want to view and edit. Apigee displays the app details. Note: Apps that are part of AppGroups are also shown in the results list. You can view app details and delete AppGroup apps, but not create or edit them in this view. For instructions on managing AppGroups and AppGroups apps, see Using AppGroups to organize app ownership.When editing an app, you can manage its credentials in the Credentials section, where you can perform the following tasks using the UI:
To use the API to manage credentials, see Import existing consumer keys and secrets.
To view an API key and secret:
Go to the Distribution > Apps page:API calls to API proxies usually require an API key. Apigee allows the calls only if the API key is approved, valid, and meets the conditions defined by the API product containing the API.
You can configure an API product for automatic approval of API keys, as described in Managing API products. However, if the API product requires manual approval of API keys, you need to manually approve the key.
You can revoke an API key for all or a single API product. In this case, the API key and secret are invalid and cannot be used to access APIs in the associated API product(s). You can re-approve an API key at any time.
To approve or revoke an API key:
Go to the Distribution > Apps page:Manage API products in your app by performing the following tasks:
To add an API product to an app:
Go to the Distribution > Apps page:If you want to keep an API key active but not allow it to be used by an API product, you can revoke it or remove it from the associated credential.
Go to the Distribution > Apps page:You can re-approve a revoked API product or re-add an API product that was removed.
You can generate new credentials for an app. For instance, if you're using API key rotation, you can generate new keys whose expiration overlaps keys that will be out of rotation when they expire. You might also generate a new key/secret if the security of the original key/secret is compromised. If you generate a new key, any existing API keys will continue to work until they expire or you explicitly revoke them.
To generate a new API key:
Go to the Distribution > Apps page:Approve or revoke an app, as described below. When you revoke an app, any approved API keys can no longer be used in API calls to Apigee. When you re-approve an app, all approved and valid API keys can be used to make API calls.
If the app is registered in other organizations, you must revoke it in each of those organizations. It may take a few minutes for the changes to be recognized by all message processors.
To approve or revoke an app:
Go to the Distribution > Apps page:When you delete an app, all client keys associated with the apps become invalid. Using an invalid key on a request causes the request to fail.
If you think you may want to reinstate a developer app in the future, an alternative to deletion is revoking an app.
To delete an app:
Go to the Distribution > Apps page:To register and manage apps using the Apigee API, use the following APIs:
See also Import existing consumer keys and secrets.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-06-09 UTC.