Skip to main content
Feedback

Subscribing to an API

Subscribe to an API in the Subscriptions column of the Configure APIs and Applications > Applications page.

Before you begin

  1. Add a plan to an API.
  2. Create an application.

About this task

Each subscription to an Application allows you to specify a unique plan for the subscription and provides a unique API Key for that Application. Providing your API consumers the API Key allows you to set up limits to their API requests without setting up an authentication provider.

Procedure

  1. On the Applications page, navigate to the Application that you want to add a subscription for.

  2. Click 0 Subscriptions.

    The Subscriptions screen opens.

  3. Click Subscribe.

  4. In the Choose one or More APIs dialog box, use the Branch drop-down to select the branch you want to work with.

The drop-down lists all branches available for your account. When you select a specific branch, the list of APIs in the dialog automatically updates to show only those deployed from that branch. Any search performed within the subscription dialog applies only to the branch currently selected in the drop-down.

The system manages the branch selection based on default settings and user activity across the platform. If you have already selected a specific branch while navigating to any other API Management page, that same branch automatically appears as selected when you open this dialog.

  1. Check the box next to one or more APIs of the selected branch and click Next.

  2. On the Choose a Plan screen, select a plan for the subscription. Then, click Next.

    The Set Subscription Details screen opens.

  3. For APIs that are deployed to an environment that does not contain an API Gateway, specify if the Subscription is enabled or disabled.

  4. For APIs that are deployed to an environment that contains an API Gateway, select a date on which the subscription should be enabled and optionally when it is to be disabled.

  5. Repeat steps 5 through 7 for the other APIs that you selected in step 4.

  6. Click Finish.

    The Plan name is listed in the Plan column for the API.

  7. Then, click Back to Applications to return to the Applications page.

On this Page