Setting API properties

You define your API through the use of API properties.

About this task

API properties include property name, value, and the Catalog to which the property applies. For a list of API properties relating to invoke and proxy policies, see API properties.

Procedure

To set API properties, complete the following steps:

  1. If you have not previously pinned the UI navigation pane then click the Navigate to icon The Navigate to icon.
    The API Manager UI navigation pane opens. To pin the UI navigation pane, click the Pin menu icon The Pin menu icon..
  2. Click Drafts in the UI navigation pane, and then click APIs.
    The APIs tab opens.
  3. Click APIs.
    The APIs tab opens.
  4. Click the API definition that you want to manage.
  5. In the Properties section, click the Add property icon The Add property icon, then click the new property to expand its details.
  6. In the Property Name field, enter the property name.
    Note: The property name must begin with either a letter or a _ (underscore) character.
  7. In the Description field, enter a description for the property.
  8. Select the Encode check box if you want to hide the property values, or protect user passwords from casual observance.
    Note: If you encode a property value, it is saved in Base64 encoded form; it is not encrypted. If you subsequently clear the Encode check box, the original property value is restored in its unencoded form.
  9. In the Default Catalog's Value field, specify the default property value.
  10. Optional: Add a value for another Catalog.
    1. Click Add value.
    2. Icon indicating that this applies only to the API Designer UI In the new value's Catalog field, enter the name of the Catalog for which you want to set the property value. This must match the name of a Catalog in API Manager and cannot be used when testing offline.
    3. Icon indicating that this applies only to the API Manager UI In the new value's Catalog field, select the Catalog for which you want to set the property value.
      Note: The value apic-dev in the list refers to the Catalog name that is reserved for testing offline in the developer toolkit. For instructions, see Configuring API definitions for container run times at ../com.ibm.apic.install.doc/tapim_migrating_to_containers.html.
    4. In the new value's Value field, enter the property value that is specific to the selected Catalog.
  11. Click the Save icon The Save icon. to save your changes.