Labels

Labels allow you to categorize and tag your API definitions and versions so that you can discover and use them efficiently.

With labels, you can dynamically filter your API registry to only display relevant APIs.

attention

Labels are only a mechanism to categorize and organize your API definitions and versions. Adding specific label names will not affect access control for the API definitions and versions.

For example, adding an Internal label and assigning it to an API version does not imply the API version can be accessed by internal staff only. You will have to specifically set access control for these API versions.

Add labels

Use the Settings > Labels page to add new labels.

  1. Log in to your organization in Workflows and select Settings.
  2. From the left, select Labels. The Labels page displays. Labels page
  3. Select New Label.
  4. For a new label, complete the following:

    • Label name: Type in a name for your label. This is the name that will be displayed in your API registry once you assign this label to the API definition or version.
    • Description (optional): Type in a description for your label. Descriptions are for additional details only.
    • Color: Type in a hex code to assign a specific color for this label. You can also use the auto icon next to the hex code field to automatically generate a random color.

      info

      As you start creating your label, an automatic preview is generated right above the label. For example, we created an Internal label, put in a description and assigned a color to this label.

      Add new label

  5. Select Create Label to save your changes. A new label is created and displayed in the labels list.

Edit labels

To edit labels, including label name, description or color, navigate to the Settings > Labels page and select the Edit (pencil) icon. Make your changes and select Save changes.

The label details are updated for all API definitions and versions where this label has been assigned.

Delete labels

To delete labels, navigate to the Settings > Labels page and select the Delete icon. The label is deleted and unassigned automatically from all API definitions and versions where it may have been previously assigned.

Assign labels

You can assign labels to both API definitions and API versions from the API registry.

Assign a label to an API definition

  1. Log in to your organization in Workflows and select API registry.
  2. On the API registry page, select the API definition you want to assign the label and select Edit API. The API definition details display.

    Edit API definition

  3. On the API definition details page, under Labels, select the Edit icon. The Labels dialog displays.

    Labels

  4. Tick to select and assign labels to this API definition. For example, select the Internal label we created in Settings > Labels.

    Select labels

  5. Once you have selected the labels you want to assign, select Save definition. The selected label is assigned to the API definition and displayed on the API registry page.

    Assigned labels

To unassign the label, navigate to the API definition details page, deselect the label, and save your changes.

Assign a label to an API version:

  1. Log in to your organization in Workflows and select API registry.
  2. On the API registry page, select the API version you want to assign the label. The API version details display.

    API version details

  3. On the API version details page, under the version name, select the Edit icon. The Labels dialog displays.

    Version labels

  4. Tick to select and assign labels to this API version. For example, select the Docs label. The selected label is automatically assigned to the API version.

    Version assigned label

To unassign the label, navigate to the API version details page, and deselect the label.