API Manager operations

Use API Manager operations to explore and manage resources in your IBM® API Connect provider organization. These operations help you discover available catalogs, retrieve published APIs, products, and gateways, and control the number of results returned that uses pagination parameters.

The API Manager operations help you interact with and manage resources in your IBM API Connect provider organization. These operations are especially useful for developers, testers, and administrators who need to complete the following actions:

  • Discover available catalogs in the organization.
  • Retrieve published APIs, products, and gateways from specific catalogs.
  • Control the volume of data returned that uses pagination parameters like limit and skip.
The API Manager supports the following operations:

List catalogs

List catalogs from an IBM API Connect provider organization. Limit and offset values are used to control the number of catalogs returned.

Table 1. Parameters
Field name Type Default value Description
Limit (optional) Integer 100 Maximum number of catalog rows to return.
Skip (optional) Integer 0 Number of rows to skip before the results are displayed based on the limit.

You can use the following prompts to list catalogs

Table 2. Prompts
Action Prompts
List catalogs 
list catalogs
list catalogs with limit 20
list catalogs with offset 5
list catalogs with limit 10 and offset 3
get me all the catalogs with limit 5 and offset 1
can you list the catalogs in API Connect provider organization using limit 50 and offset 20

List published APIs

Lists published APIs from a catalog in an IBM API Connect instance provider organization. It takes the catalog name as input and returns all the APIs published to that catalog. List APIs is the same as listing published APIs.

Table 3. Parameters
Field name Type Default value Description
Catalog String Sandbox ID or name of the catalog from which the APIs are listed.
Limit (optional) Integer 10 Maximum number of rows to return.
Skip (optional) Integer 0 Skip this number of rows and return the remaining rows according to the limit set.

You can use the following prompts to list published APIs.

Table 4. Prompts
Action prompts
List published APIs, products, or gateways 
list apis
list published apis
list published apis with limit 30
list published apis with offset 15
list published apis with limit 10 and offset 3
I would like to get the published apis in API Connect provider organization using limit 50 and offset 20
list published apis in catalog xyz
list apis in catalog with name testing2
list apis in catalog with name testing2
list published apis from catalog abcd with limit 30
list published apis with limit 10 and offset 3 and in catalog with name test-catalog
get me the published apis in API Connect provider organization catalog staging and using limit 10

list apis from catalog legacy-apps
list apis with limit 20 and offset 5

List published products

Lists published products from a catalog in an IBM API Connect instance provider organization. It takes the catalog name as input and returns all the products that are published to that catalog. List products are the same as listing published products.

Table 5. Parameters
Field name Type Default value Description
Catalog String Sandbox ID or name of the catalog from which the APIs are listed.
Limit (optional) Integer 10 Maximum number of rows to return.
Skip (optional) Integer 0 Skip this number of rows and return the remaining rows according to the limit set.

You can use the following prompts to list published products.

Table 6. Prompts
Action prompts
List published APIs, products, or gateways 
list products
list published products
list published products with limit 30
list published products with offset 15
list published products with limit 10 and offset 3
I would like to get the published products in API Connect provider organization using limit 50 and offset 20

list published products in catalog xyz
list products in catalog with name testing2
list products in catalog with name testing2
list published products from catalog abcd with limit 30
list published products with limit 10 and offset 3 and in catalog with name test-catalog
get me the published products in API Connect provider organization catalog staging and using limit 10

list products from catalog legacy-apps
list products with limit 20 and offset 5

List gateways in catalog

Lists gateways from a catalog in an IBM API Connect instance provider organization. It takes the catalog name as input and returns all the configured gateways from that catalog.

Table 7. Parameters
Field name Type Default value Description
Catalog String Sandbox ID or name of the catalog from which the APIs are listed.
Limit (optional) Integer 10 Maximum number of rows to return.
Skip (optional) Integer 0 Skip this number of rows and return the remaining rows according to the limit set.

You can use the following prompts to list published products.

Table 8. Prompts
Action prompts
List published APIs, products, or gateways 
list gateways
list gateways in catalog
list gateways in catalog with limit 30
list gateways in catalog with offset 15
list gateways in catalog with limit 10 and offset 3
I would like to get the gateways in API Connect provider organization using limit 50 and offset 20
list gateways in catalog xyz
list gateways in catalog with name testing2
list gateways from catalog abcd with limit 30
list gateways with limit 10 and offset 3 and in catalog with name test-catalog
get me the gateways in API Connect provider organization catalog staging and using limit 10
list gateways in catalog legacy-apps
list gateways with limit 20 and offset 5