Manage plugin instances

This page applies to Apigee and Apigee hybrid.

This page describes how to create and manage plugin instances in API hub.

Create a plugin instance

Edit a plugin instance

You can edit an existing plugin instance to update its display name or modify its curation settings. To edit a plugin instance, perform the following steps:

  1. In the Google Cloud console, go to the API hub page.

    Go to API hub

  2. Click Settings from the left navigation menu to open the Settings page.
  3. Click the Plugins tab and go to the Manage instances section to view the list of plugin instances in your project.
  4. For the plugin instance that you want to edit, click (Plugin instance actions) and then select See details.
  5. In the Plugin details pane, you can:
    • Edit the Instance name of the instance.
    • Modify the Curation logic.
  6. Click Save to apply your changes.

Sync a plugin instance

Plugin instances are automatically synced with the data source at the specified frequency. You can also manually sync the plugin instance with the data source. To manually sync a plugin instance, perform the following steps:

  1. In the Google Cloud console, go to the API hub page.

    Go to API hub

  2. Click Settings from the left navigation menu to open the Settings page.
  3. Click the Plugins tab and go to the Manage instances section to view the list of plugin instances in your project.
  4. For the plugin instance that you want to sync, click (Plugin instance actions) and then select Run.

    API hub starts to sync the plugin instance with the data source and the status is updated to Running. Once the sync is complete, the status is updated to Active.

Import API metadata from multiple projects

You can attach multiple Apigee and Apigee hydrid runtime projects to the Apigee and hybrid plugin instance. This allows you to ingest API metadata from multiple Apigee and hydrid organizations or environments into API hub using that single plugin instance. For information about attaching a runtime project to API hub, see Attach a runtime project.

Disable a plugin instance

Disabling a plugin instance stops the sync of the plugin instance with the data source. You can still view the plugin instance in API hub and its associated data. To disable a plugin instance, perform the following steps:

  1. In the Google Cloud console, go to the API hub page.

    Go to API hub

  2. Click Settings from the left navigation menu to open the Settings page.
  3. Click the Plugins tab and go to the Manage instances section to view the list of plugin instances in your project.
  4. For the plugin instance that you want to disable, click (Plugin instance actions) and then select Disable.

    API hub stops the sync of the plugin instance with the data source and the status is updated to Disabled.

  5. Optional: To enable the plugin instance again, click (Plugin instance actions) and then select Enable.

Delete a plugin instance

To delete a plugin instance, perform the following steps:

  1. In the Google Cloud console, go to the API hub page.

    Go to API hub

  2. Click Settings from the left navigation menu to open the Settings page.
  3. Click the Plugins tab and go to the Manage instances section to view the list of plugin instances in your project.
  4. For the plugin instance that you want to delete, click (Plugin instance actions) and then select Delete.
  5. In the confirmation dialog, click Delete to confirm the deletion of the plugin instance.

What's next