Manage API Entitlements

An entitlement is the relationship between an API and a plan. Review the topics to manage API entitlements.

Topics:

• Understand API Entitlements

• View API Entitlement Details

• Add an Entitlement to an API

• Publish and Unpublish an Entitlement in an API

• Activate and Deactivate an Entitlement in an API

• Remove an Entitlement from an API

Understand API Entitlements

An entitlement is the relationship between an API and a Plan that defines how a client application can access the API.

There is a many-to-many relationship between plans and APIs. A given plan can have entitlements to multiple APIs; for example, to group related APIs. A given API can be entitled by multiple plans; for example, to provide different quality of service criteria. Note that two entitlements of the same plan cannot point to the same entire API, or to the same action in an API.

View API Entitlement Details

You can view the entitlements that are added to the API and other details such as whether the entitlement is active or inactive and whether it is published or unpublished.

To view details of an entitlement:

1. On the APIs List page, click the API for which you want to view the entitlements.
2. Click the (Entitlements) tab.
3. To filter the list for active or inactive entitlements, click the Active or Inactive tab.
4. To filter the list for published or unpublished entitlements, click the Published or Unpublished tab.
5. To see all entitlements, click the All tab.
6. To view more details about an entitlement, click its name or the Expand icon to the right.

Add an Entitlement to an API

You can add an entitlement to an API from the API component.

To add entitlement to an API:

1. On the APIs List page, click the API to which you want to add an entitlement.
2. Click the (Entitlements) tab.
3. Click Add Entitlement.
4. Select the plan in the Add Plan window that appears.
   You can add entitlements to multiple plans.
5. Choose either Active or Inactive to set the initial state of the entitlement.
6. Click Add.

Publish and Unpublish an Entitlement in an API

You must publish an entitlement in an API to enable the application developer to access it from Developer Portal.

To publish or unpublish an entitlement in an API:

1. On the APIs List page, click the API that you want to publish or unpublish.
2. Click the (Entitlements) tab.
3. Click the name of the entitlement you want to publish or unpublish.
4. Click the Publish or the Unpublish button that appears.
   These buttons interchange depending on the publication state of the entitlement.
5. Click Yes.

Activate and Deactivate an Entitlement in an API

You must activate the entitlement in an API for the application developer to access it from developer portal.

To activate or deactivate an entitlement in an API:

1. On the APIs List page, click the API for which you want to activate or deactivate an entitlement.
2. Click the (Entitlements) tab.
3. Click the name of the entitlement you want active or deactivate.
4. Click the Activate or the Deactivate button that appears.
   These buttons interchange depending on the publication state of the entitlement.
5. Click Yes.

Remove an Entitlement from an API

You can remove an entitlement from the API that is not required.

To remove an entitlement from an API:

1. On the APIs List page, click the API from which you want to remove an entitlement.
2. Click the (Entitlements) tab.
3. Click the name of the entitlement you want to remove.
4. Click the Remove button.
5. Click Yes.