API Agent settings

The API Agent settings allow you to work with IBM® Code Engine for deploying applications.

Before you begin

Enable API Agent on the management CR before you configure the API Agent settings. For more information about enabling API Agent, see Enabling API Agent for the management subsystem.

To configure the API Agent settings, complete the following steps:

1. Log in to API Manager.
2. On the Settings page, click the API Agent tab.
3. On the API Agent tab, if you are configuring API Agent sources for the first time, click Configure. If you previously configured API Agent sources, click Edit to modify the existing configuration.
4. To use your credential as the default credential for API Agent, in the API Agent Configuration dialog box, in the API Agent status section, set Disabled to Enabled, and then click Save.
5. Optional: Enable the Code Engine settings.
   1. In the API Agent Configuration dialog box, expand Code engine (Optional), and click Add. For more information about how the deployment works, see Code deployment tool.
   2. In the Add Code Engine dialog box, enter the following details:

      API key:

      The IBM Cloud® IAM API key.

      Resource group:

      The name of the resource group in which the Code Engine service is attached.

      Registry namespace

      Create a namespace in the IBM cloud registry for the Code Engine service to push and retrieve build images.

   3. To use your API Agent credentials as the default credential for API Agent, set Enable user managed code engine to Enabled and then click Save.
   4. In the Configuration API Agent dialog box, click Save.
   5. To disable, update, or delete the Code engine settings, expand Code engine (Optional), and then select the Overflow menu.