Configuring an API Control Plane source

For information on the roles and privileges needed for APIM and API Control Plane usage, refer to API Management Roles and Privileges.

Adding an API Control Plane source

You can access the API Control Plane source with a subscription. The APIs are pulled directly from your API Control Plane. You can select only one API at a time. If you have not created any APIs, refer to APIs in Control Plane.

1. Navigate to Agent Garden > Sources > Create New Source > API Control Plane > Add Source.
2. Enter a Name and Description for the API Control Plane source.
3. Select the API you wish to use. To proceed, you must select one API. For more details on the API, click the Details link.
4. Click Continue.
5. Select the Endpoints you wish to include. These endpoints then become individual API tools. You can add more endpoints at any point in time, refer to Update sources.
6. Click Continue.
7. Review and click Save.

Next steps: Configuring and deploying API tools.

Updating a source

Updating the Name, Description and adding new endpoints

You can only update the Name, Description and Endpoints of your API Control Plane source.

1. Navigate to Agentstudio > Agent Garden > Sources.
2. Select the API Control Plane source.
3. To edit a source, click on its name in the API Control Plane. You can only change the source's name and description in the configuration screen. To select another API, you must create a brand new source entry.
4. In the endpoints screen, you can import new endpoints.
5. Click Save. When you click Save, the system updates the sources and changes the status to Active.

Enabling, Disabling and Deleting a source entry

If you wish to enable, disable or delete a source entry:

1. Click the menu under actions and you can choose to perform one of the following options:

• Enable: To enable a disabled source.
• Disable: To Disable an active source.
• Delete: To delete an API Control Plane source entry.

You can only delete API Control Plane sources and tools when they are not associated with an agent.

Managing API Control Plane tools

Each endpoint you select for your API Control Plane source creates a new API Tool. The system keeps this tool in the draft stage until you configure it. For more information on creating the API tool and its components, refer to Creating an API Tool.

Configuring and deploying tools

To configure the API tools created from your newly imported endpoints perform the following:

1. Navigate to Agentstudio > Agent Garden > Tools.
2. Select the menu under Actions of the newly created API tool and select Edit.
3. The name and description is auto-populated. Enter your input parameters or use the Suggest Parameters option.
4. In the Configuration screen, the name of your API Control Plane source is present under Source Name, along with the base URL and other details auto-populated. Enter your values for the Path Parameters, Query Parameters and Headers.
5. By default, the authentication is set to None. You can configure it according to your requirements. Select Save & Continue.
6. Review and select Deploy Tool.

Once you deploy the tool, it becomes active. Similarly, proceed with the other tools created.