Working with API Plans

This section describes how Portal Admins or API Owners work with API plans, which includes the following functions:
Turn On API Plans
To use API plans, a Portal Admin must turn them on.
Prerequisite:
Ensure that you have met the prerequisites for managing API plans.
For more information about these prerequisites, see Manage API Plans.
  • Turning on API plans is a one-time change. You cannot turn off API plans after you have turned them on.
  • API plans are not compatible with API groups; switching on API plans means that you are no longer able to use API groups.
Follow these steps:
  1. From the menu bar, select
    Manage
    ,
    API Plans
    .
    The
    API Plans
    page opens.
  2. Click
    Turn On API Plans Now
    .
API plans are turned on.
Manage API Plans
You can also manage API Plans by way of the Portal API (PAPI), or use PAPI in your scripts for managing API plans.
For more information about the PAPI, see Portal API (PAPI).
Portal Admins and API Owners can manage API plans. They can do the following:
  • Set up rate limits and quotas for the API plan.
  • Attach public and private APIs to the API plan.
  • Assign which organizations can use the API plan.
The API Plans page displays a list of the API plans.
Add an API Plan
Follow these steps:
  1. From the
    API Plans
    page, select
    Add API Plan
    .
    The API Plan page opens.
  2. In the
    Edit Details
    section, complete the following, and then select
    Next
    :
    Setting
    Description
    Name
    Enter a name for the API plan.
    Required:
    Yes
    The name must be unique and cannot exceed 50 characters, which can contain letters, numbers, hyphens (-), and underscores (_).
    Enable quota for this plan
    Limits the number of times an API key can query the API associated with this plan. Enter the maximum number of hits for the selected time period.
    Enable rate limits for this plan
    Limits the number of concurrent requests an API key can send requests to the API associated with this plan. Enter the maximum number of requests for the selected time period.
    Setting a low value, such as 50 requests per second, can prevent your API from being overwhelmed by multiple simultaneous requests, which may happen with Denial-of-Service attacks or poorly programmed applications.
    Ensure that your API plans have lower rate limits that your account plans.
    Public Description
    Enter a description that can help API Owners, Org Admins, and Developers understand the service level provided by the API Plan to make informed selection for their applications.
    If you want to link an organization to an API plan, the organization must already have access to
    all
    the APIs attached to the plan. The counter in
    Available Organizations
    shows you how many organizations have access to all the selected APIs on the
    Assign APIs
    page. This counter helps you understand how many Organizations you can potentially make the plan visible to, based on the APIs selected. If the Organization count is 0, this means the API has not been added to an account plan or organization.
    For more information, see Manage Account Plans.
  3. In the
    Add APIs
    section, select
    Add
    to add the public or private APIs displayed in the
    Available APIs
    list. You can make an entry in the
    Filter
    search box to display a filtered list of available APIs. The APIs you add display in the
    Selected APIs
    list. Select
    Remove
    to remove the API from the API Plan. A pop-up window opens prompting you to confirm the remove.
  4. Select
    Next
    .
  5. In the
    Assign Organizations
    section, select
    Add
    to add the organizations linked to the APIs you assigned to the API Plan. You can make an entry in the
    Filter
    search box to display a filtered list of available organizations. If 0 organization is displayed in the
    Available Organizations
    list, you need to assign it to an Organization. The organizations you add display in the
    Selected Organizations
    list. Select
    Remove
    if you want to remove the organization from the API plan. A pop-up window opens prompting you to confirm the remove.
  6. Select
    Create
    .
    A notification displays on the
    API Plans
    page that you have added an API plan.
Edit an API Plan
Follow these steps:
  1. From the
    API Plans
    page, select the API plan that you want to edit.
    The API plan opens, displaying the information for that API plan.
  2. (Optional)
    In the
    References
    section, select
    APIs
    ,
    Applications
    , or
    Organizations
    to display a list of the APIs, applications, and organizations assigned to the API plan.
  3. Select
    Edit
    .
    The
    Edit API Plan
    page opens.
  4. Update the settings as needed in the
    Edit Details
    ,
    Assign APIs
    , and
    Assign Organizations
    sections.
  5. Select
    Save
    .
Delete an API Plan
From the
API Plans
page, select
Delete
next to the API plan that you want to delete.