API Connect Task

The API Connect Task tool performs operations on an API Connect instance (on-premises and SaaS) and IBM webMethods Hybrid Integration (iPaas) API Connect instance. Once API Agent is enabled and configured in API Connect instance, you can use the Visual Studio Code plug-in chat interface to connect to a provider organization and input prompts to use the following operations.

Catalog-dependent operations

For the following operations, the specified catalog must be enabled for API Agent in the API Manager UI. If the catalog is not enabled, the operation fails. For more information about catalog and drafts, see API Connect catalogs and drafts.

  • List gateways in catalog
  • List consumer organizations
  • List applications in catalog
  • List published APIs
  • List published products
  • List consumer app credentials
  • Publish API
  • Publish product
  • Create consumer app
  • Create subscription

Draft-dependent operations

To use the following operations, drafts must be enabled for API Agent in the API Manager UI:

  • Create draft API
  • Download draft API
  • Delete draft API
  • Update draft API
  • List draft APIs
  • List draft Products
  • Validate draft API (when working with a draft)
  • Review security of a draft API
  • Add security to a draft API
  • Remove security from a draft API

Draft-independent operations

The following operations work regardless of whether drafts are enabled or disabled in the API Agent settings:

  • Create API Connect API that uses a URL
  • Create API Connect API from file @filename
  • Validate API in file @filename
  • Review security of API in file @filename
  • Add security to an API in a file @filename
  • Remove security from an API in a file @filename
Note:
  • Any changes that are made to the API Agent settings, such as enabling catalogs or drafts, or database configuration changes, in the API Manager UI take effect only in new chat sessions. The existing sessions do not reflect the updated configurations.
  • When writing prompts to use an existing resource, the prompt must include the name (or ID) of the object or resource. Providing the title of the resource as input can cause errors. The resources that require a name or ID as input includes the following details:
    • Catalogs
    • Draft APIs
    • Draft products
    • Published APIs
    • Published products
    • Gateways
    • Consumer organizations
    • Consumer applications
    • Subscriptions
  • Spaces feature in API Connect is not supported from API Agent.

The following section describes different operations supported by the API Connect Task tool.