---
title: Administering API groups
description: This topic discusses administrative tasks associated with your application programming interface (API) groups.
component: pingintelligence
version: 5.2
page_id: pingintelligence:managing_pingintelligence_for_apis:pingintelligence_administering_api_groups
canonical_url: https://docs.pingidentity.com/pingintelligence/5.2/managing_pingintelligence_for_apis/pingintelligence_administering_api_groups.html
revdate: April 3, 2024
section_ids:
  before-you-begin: Before you begin
  about-this-task: About this task
  creating-and-deleting-api-groups: Creating and deleting API groups
  steps: Steps
  adding-deleting-and-moving-apis: Adding, deleting, and moving APIs
  steps-2: Steps
  merging-a-user-defined-api-group-into-the-default-api-group: Merging a user-defined API group into the default API group
  about-this-task-2: About this task
  steps-3: Steps
  searching-or-sorting-api-groups-and-apis: Searching or sorting API groups and APIs
  steps-4: Steps
---

# Administering API groups

This topic discusses administrative tasks associated with your application programming interface (API) *(tooltip: \<div class="paragraph">
\<p>A specification of interactions available for building software to access an application or service.\</p>
\</div>)* groups.

## Before you begin

Make sure you have admin user privileges to administer the API groups in the dashboard.

## About this task

You can perform the following administrative operations on API groups:

* [Creating and deleting API groups](pingintelligence_creating_deleting_api_groups.html)

* [Adding, deleting, and moving APIs](pingintelligence_adding_deleting_moving_apis.html)

* [Merging a user-defined API group into the default API group](pingintelligence_merging_api_group.html)

* [Searching or sorting API groups and APIs](pingintelligence_searching_sorting_apis.html)

|   |                                                                                                                                                                                                                                                             |
| - | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|   | A successful execution of these operations is followed by a success notification. Click the **Refresh** ![A screenshot of the Refresh button.](_images/jie1602140098489.png) button on the top-right corner, to reflect the changes made to the API groups. |

## Creating and deleting API groups

### Steps

* To create an API *(tooltip: \<div class="paragraph">
  \<p>A specification of interactions available for building software to access an application or service.\</p>
  \</div>)* group, click **Create New API group** on the top-right corner. Fill in the following details for the new API group, and click **Save**:

  * **Group name**: The display name of the API group.

  * **Group description**: Additional information about the API group.

  * **Custom attribute key**: The metadata key for the API group.

  * **Custom attribute value**: Metadata about the API group. This can be used in search operations.

    ![Screen capture of PingIntelligence create new API group popup window showing.](_images/bye1640167393569.png)

* Click the **Pencil** ![nua1601190800641](_images/nua1601190800641.png) icon, to edit an API group. You can modify the metadata of the group.

* Click the **Delete** ![flm1601182421248](_images/flm1601182421248.png) icon on the bottom-right corner of the API group, to delete an API group. APIs in the group that are not part of any other API groups, will be added to the default API group. You cannot delete the default API group.

## Adding, deleting, and moving APIs

You can add, delete, or move an API *(tooltip: \<div class="paragraph">
\<p>A specification of interactions available for building software to access an application or service.\</p>
\</div>)* from an API group.

### Steps

* To add an API to group, click **Add APIs** on the top-right corner of the API group. Select the API from the **Add APIs to the Group** pop-up and click **Submit**. You can select more than one API and add them to a group in one instance.

  ![Screen capture of the PingIntelligence Add API to group page.](_images/its1601183586643.png)

* To delete an API from an API group, click **Move API**. Select **Delete API** in the **Move/Delete from the Group** pop-up. Click **Submit**. After an API which does not belong to any other group is deleted from a group, then it automatically gets added to the default group.

  ![Screen capture of the PingIntelligence Delete API from group page.](_images/tqe1601259242494.png)

* To move an API to a different API group, click **Move API**. Select **Move API** in the **Move/Delete from the Group** pop-up. Now select the target API group and click **Submit**. You can move the API to more than one target API groups. Once the API is moved it'll no longer be part of that API group.

  ![Screen capture of the PingIntelligence Move API to group page.](_images/fck1601188700848.png)

## Merging a user-defined API group into the default API group

You can merge a user-defined API *(tooltip: \<div class="paragraph">
\<p>A specification of interactions available for building software to access an application or service.\</p>
\</div>)* group into the default API group.

### About this task

Complete the following steps:

### Steps

1. Click **Settings → API grouping settings**.

2. From the **Select group** list, select the API group that you want to move to the default group.

3. Click **Save**.

![Screen capture of the PingIntelligence API default group settings, select group showing.](_images/yoz1640173355917.png)

## Searching or sorting API groups and APIs

### Steps

* You can search for a specific API *(tooltip: \<div class="paragraph">
  \<p>A specification of interactions available for building software to access an application or service.\</p>
  \</div>)* in an API group or across multiple API groups. For quick and easy retrieval, when you search at the API group level, you can filter your search based on **Group name**, **Attribute**, or **API**. When API is chosen for filtering, only non-empty API groups are loaded.

* You can sort API groups based on**Group name**, **Group creation date**, or **Last modified date**.

![Screen capture of PingIntelligence API group sorting, group name, creation date, and last modified date showing.](_images/bog1640174026568.png)

* You can also sort the APIs within an API group based on**Creation date** or **Training start date**.

![Screen capture of PingIntelligence API grouping - group based sorting showing.](_images/iho1640174184806.png)
