Manage API Groups

API groups are collections of APIs that Org Admins and Developers can consume.
cl7ap
API plans have been introduced as of CA API Developer Portal version 4.3.2.
If you have turned on API plans, you will no longer be able to use API groups.
As a Portal Admin or API Owner, you can add, edit, deprecate, and delete API groups. API groups are collections of APIs that Org Admins and Developers can consume. You can group your APIs across your organizational and business boundaries by adding them to API groups. Org Admins and Developers can consume API groups while adding and editing their applications.
For more information about the roles and permissions for managing API groups, see Get Started - User Types, Roles and Permissions.
You can also manage your API groups by way of the Portal API (PAPI) or use this API in your scripts for managing API groups.
For more information about the Portal API, see Portal API (PAPI).
In this article:
Create an API Group
  1. Select the
    Services
    icon.
  2. Select
    Publish
    ,
    API Groups
    .
    The list of API Groups appear on the API Groups page.
  3. Select
    Add API Group
    .
    The Add API Group page opens.
  4. In the
    Group Details
    section of the page, complete the following fields:
    API Group Name
    The name of the API group that you are creating.
    Unique:
    Yes
    Maximum length:
    255
    Required:
    Yes
    Description
    The description of the API group that you are creating.
    Maximum length:
    255
    Required:
    No
  5. Add and remove APIs to your API group. In the
    APIs
    section of the page, the
    Available APIs
    section lists the APIs that you can add to your API group. You can only add enabled APIs to your API group. To add an API to your API group, next to the API that you want to add to your API group, select
    Add
    .
    Because this API group is new and you have not added APIs to your API group yet, the Selected APIs
    section is empty.
  6. Select
    Save
    .
Your API group is created. See your group in the list on the
API Groups
page. The API group is enabled by default.
View your List of API Groups
You can view your list of API groups on the API Groups page. The following information is displayed:
  • The state of each API group
  • The number of applications that have added the API group
  • The number of organizations that are associated to the API group
Edit an API Group
You can edit your API groups, including those API groups an Org Admin or Developer has added to their application.
You can edit your API group in the following ways:
  • Add APIs to your API group.
  • Remove APIs from your API group.
  • Change the API group name.
  • Change the API group state.
Add and Remove APIs from an API Group
You can add public and private APIs to your API group. You can remove only APIs that an Org Admin or Developer has not already added to their applications by way of your API group.
Follow these steps:
  1. From the API Groups page, on the Actions menu next to the API group you want to delete, select
    Edit
    .
    The Edit API Group page appears.
    If you already added an API to your API group and the state of the API changes from enabled to disabled, the following message appears at the top of the
    Edit API Group
    page:
    This API Group contains disabled APIs and will not be available for applications of same organizations.
    Applications within your organization can only use API groups that include enabled APIs. Applications within all other organizations can use API groups that include disabled APIs.
    Best Practice:
    Remove disabled APIs from your API group.
  2. Do the following:
    • Add APIs to the API group:
      In the APIs section of the page, in the
      Available APIs
      section, next to the API that you want to add to your API group, select
      Add
      . Only enabled APIs are listed.
      The API is added to the
      Selected APIs
      section.
    • Remove APIs from the API group:
      In the APIs section of the page, in the
      Selected APIs
      section, next to the API that you want to remove, select
      Remove
      .
      The API is removed from the
      Selected APIs
      section.
  3. Select
    Save
    .
Your changes to the API group are saved.
Edit the State on an API Group
You can change the state of your API groups to enabled or deprecated. From the Edit API Group page, in the Group Details section of the page, select
Enabled
or
Deprecated
, and then select
Save
.
Delete an API Group
Prerequisite:
An Org Admin or Developer has not added the API group to an application (the application is not using the API group).
  1. From the API Groups page, on the Actions menu next to the API group you want to delete, select
    Delete
    .
  2. Select
    Ok
    to confirm the deletion of the API group.
The API group is deleted and no longer displays on the API Groups page.