Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Plans must be managed within the scope of an organization. Once created, plans can be used for any API defined within that same organization.

You can display the list of existing plans for an organization by navigating to the Plans tab for that organization on its details page:

Click on the name of a plan to open its details page:

Use the Plan Details page to modify the plan's meta-data and policies. Once you have fully configured the plan, do not forget to lock it.

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamenote_on_plan_usage
PageWithExcerptINTERNAL:_api_excerpts

Basic Settings

The basic settings of the plan are displayed in the frame on top:

  • Name of the plan
  • Description (changeable, click to open the editor)
  • Creation date
  • Creator
  • Status of the plan (or )

Plan Details

Underneath the basic settings of the plan its details can be configured. Use the tabs on the left side of the page or the links on the overview page to navigate to the different details:

  • Overview
  • Policies
  • Change Log

Policies

The Policies tab allows you to manage the policies that should be applied whenever a request is made to an API via this plan. To add another policy to this plan, use the Add Policy button. You will be redirected to the page Add Policy, where you can choose a policy and customize it:

Multiexcerpt include
MultiExcerptNameapi_link_to_policy_page
DisableCachingtrue
PageWithExcerptINTERNAL:_api_excerpts

Multiexcerpt include
MultiExcerptNameapi_move_policies
PageWithExcerptINTERNAL:_api_excerpts

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNameclick_to_see_gif
PageWithExcerptINTERNAL:_general_excerpts

If you want to delete a policy from this plan, use the Remove button of the policy in question.

Change Log

Navigate to the Change Log tab if you want to see an overview of the plan activity. All configuration changes made by API Management users associated with this plan are listed here:


Panel
titleOn this Page:

Table of Contents


Panel
titleRelated Pages:

Otp
Floatingfalse
maxHLevel2

rp