Skip to content

Application Details (Keys, Details & Usage)

In this tutorial, you’ll learn how to view and update an Application: keys, subscription configuration, and usage.

Open an application

  • From the API Manager home screen, go to Manage APIs → select Application.

Accessing Application Functionality

  • In the View column, click for the application.

The application opens with tabs: Keys, Details, and Usage.

Keys

  • Select the Keys tab.

The Keys tab provides:

  • X-Yappes-Key — required to validate requests entering the Yappes Platform (Applications Keys)
  • Public Key (X-Yappes-Subkey) — subscription tryout key passed as the x-yappes-subkey header
  • Private Key — for Message Signature policy
  • Use Copy / Copied on a key field to copy its value.

Regenerate X-Yappes-Key

Regenerate when you need to invalidate the current application key without deleting the application.

  • On the Keys tab, under Applications Keys → X-Yappes-Key, click the regenerate icon.
  • In the Regenerate Key window, confirm that regenerating replaces the current key and cannot be undone, then click Regenerate.

The key is successfully regenerated.

Details (subscription and OAuth scopes)

The Details tab is where you edit an application's subscription configuration, including rate plans, Yappes OAuth scopes, and custom attributes.

Path: Manage APIs → Application → View → Details

  • Select the Details tab.

Editable fields

Field Editable on update
Application Name No (disabled)
Description Yes
Select Environment Yes
Attach to No (disabled)
Select APIs / Select API Group Yes
Rate plans Yes (same UI as create)
OAuth scopes Yes (via API pills and scope modal)
Custom Attributes Yes (optional; Add Attributes)
  • To change which APIs or API groups are attached, update Select APIs or Select API Group, adjust rate plans and scopes as needed, then click Update.

Update OAuth scopes

When the application includes Yappes OAuth-enabled APIs:

  • OAuth-enabled APIs appear as pills under OAuth enabled API (Click API to view the Scopes).
  • Click an API pill to open the Api Scope Details modal.
  • Check or uncheck scopes, then click Save.
  • Click Update to save all changes to the application.

The scope selection UI matches Creating an application. For API Group subscriptions, pills list individual OAuth-enabled APIs within each group.

Note

OAuth client credentials are not shown on the Details tab. After subscription is active, view credentials in My Subscriptions.

Actions

  • Update — save description, environment, API/group selections, rate plans, custom attributes, and scope changes
  • Delete Application — remove the application (see Deleting an application)

The application is successfully updated.

For the full Yappes OAuth flow, see Yappes OAuth.

Usage

  • Select the Usage tab.
  • Select an API under Api Name:.
  • Select a quota filter: All Quota Type, Tryout, or Subscription.
  • Select the date range. By default, the last month is selected. You can view up to the previous six months of usage data.