Product-related operations

Edit online

Use the Publish product operation to publish a draft product to an API Connect instance. This operation enables the availability of product through the specified catalog and gateway services.

Publish product

Note: User confirmation is required before publishing.
Table 1. Parameters
Parameter Type Required Description
product_name string Required The name of the draft product to publish.
gateway_names string Optional A comma-separated list of gateway service names where the product is published. If not specified, the product is published to all relevant gateway services that are configured in the target catalog.
catalog string Optional The name of the catalog where the product is published.

If not specified, "sandbox" is used by default.
You can use the following prompts to publish a product.
Table 2. Publish product
Action Prompts Commands
Publish product
  • Publish a product by name (default catalog: sandbox)
    publish product sample
  • Publish a product by name to a specific catalog, for example, test
    publish product sample to catalog test
  • Publish a product by name to a specific gateway and specific catalog.
    publish product sample using gateway gw-service to catalog test
  • Publish a product by name (default catalog: sandbox)
    /publish_product name:sample
  • Publish a product by name to a specific catalog, for example, test
    /publish_product name:sample catalog:test
  • Publish a product by name to a specific gateway and specific catalog
    /publish_product name:sample gateway_names:gw-service catalog:test

Download draft product

You can download draft product from the API Connect instance.

Table 3. Parameters
Parameter Type Required Description
product_name string Yes The name of a draft product.
file_format string Optional The format in which the file will be downloaded either in the YAML or JSON format. If not specified, YAML is used by default.
You can use following prompts to download draft products:
Table 4. Download product draft
Action Prompts Commands
Download draft product
  • Download draft product by API name (default YAML file format)
    download draft product sample-product
  • Download draft product by name and in the JSON format
    download draft product sample-product in json format
  • Download draft product by API name (default YAML file format)
    /download_draft_product product_name:sample-product
  • Download draft product by name and in the JSON format
    /download_draft_product product_name:sample-product file_format:json