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
To create a plugin instance, perform the following steps:
- In the Google Cloud console, go to the API hub page.
- Click Settings from the left navigation menu to open the Settings page.
- Click the Plugins tab to view the available plugins in your project.
- Hold the pointer over the desired plugin, and then click Create instance.
- Complete the following fields in the Create a plugin instance pane:
- Display name: Enter a name for the plugin instance.
- Sync frequency: Choose the frequency with which the plugin instance should be synced with the data source. By default, the frequency is set to Hourly.
- Curation: Select the curation settings for the plugin instance. By default, the curation level is set to Default.
- Click Create to initiate the creation of the plugin instance.
You can view the status of the plugin instance in the Plugins tab under Manage instances. On successful creation, the status of the plugin instance is displayed as Active as shown in the following image:
Edit a plugin instance
API hub currently doesn't support editing a plugin instance. If you want to make changes to configurations of a plugin instance (for example, change curations logic), you must delete the existing plugin instance and create a new one.
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:
- In the Google Cloud console, go to the API hub page.
- Click Settings from the left navigation menu to open the Settings page.
- Click the Plugins tab and go to the Manage instances section to view the list of plugin instances in your project.
- 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 as shown in the following image:
Import API metadata from multiple projects
You can attach multiple Apigee X and Apigee Hybrid runtime projects to the Apigee X and hybrid plugin instance. This allows you to ingest API metadata from multiple Apigee X and Hybrid 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.
API hub automatically ingests all API metadata from the attached runtime projects when the plugin instance is synced.
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:
- In the Google Cloud console, go to the API hub page.
- Click Settings from the left navigation menu to open the Settings page.
- Click the Plugins tab and go to the Manage instances section to view the list of plugin instances in your project.
- 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 as shown in the following image:
- 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:
- In the Google Cloud console, go to the API hub page.
- Click Settings from the left navigation menu to open the Settings page.
- Click the Plugins tab and go to the Manage instances section to view the list of plugin instances in your project.
- For the plugin instance that you want to delete, click (Plugin instance actions) and then select Delete.
- In the confirmation dialog, click Delete to confirm the deletion of the plugin instance.