API Connect Task

The API Connect Task tool helps you to do various operations on an API Connect instance.

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.

  • 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 API (when working with a draft)
  • Review security of API (when working with a draft)
  • Add security to an API (when working with a draft)
  • Remove security from an API (when working with a draft)

Draft-independent operations

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

  • Create API Connect API using 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 file @filename
  • Remove security from an API in 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 takes effect in new chat sessions only. The existing sessions do not reflect the updated configurations. For more information about catalog and drafts, see API Connect catalogs and drafts.

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