Importing a draft Product

You can create a Product by importing a Product definition in a .yaml file.

Before you begin

To complete this task, you must have a .yaml representation of a Product. This can be created as described in the Downloading a draft Product task.

About this task

You can complete this task either by using the API Designer UI application, or by using the browser based API Manager UI.

You can import details of your Product as a .yaml file. This file can be used to re-create your Product, although it includes only references to APIs, not the API definitions themselves. This function does not provide a way to import an entire implementation.

You can import the file from your local file system.


To create a Product from a .yaml file, complete the following instructions:

  1. In the navigation pane, click Develop icon in the navigation pane Develop.
  2. Select the Products tab.
  3. Click Add > Product.
  4. Select Existing Product, then click Next.
  5. To import a file from your local file system, you can either drag and drop your files, or click Browse and select the file that you want to use.
    The wizard checks the validity of the YAML, and displays a message indicating successful validation.
  6. Click Next.
  7. To have the Product published to the Sandbox Catalog automatically after creation, select Publish product.
  8. Click Next to create your Product.
    1. To further configure your Product, click Edit Product.
      For details, see Editing a draft Product
    2. If you do not want to configure your Product further at this time, click the initial Develop link in the breadcrumb trail to return to the Develop page; you can then move on immediately to another task.
      For details on how to configure your Product later, see Editing a draft Product.


You have imported a Product from a .yaml file. If the same APIs and versions of APIs as referenced in the file are present, then they will be included in the Product.

Importing a Product in this way does not include the API definitions, only references to them.