Plugins overview

This page applies to Apigee and Apigee hybrid.

Plugins allow API hub to connect and ingest API metadata from external sources where your APIs are managed or defined. Currently, API hub provides a dedicated plugin for Apigee X and Apigee Hybrid. This built-in plugin is automatically set up with a plugin instance when you provision API hub in your Google Cloud project.

Why use plugins?

Plugins simplify and enhance the process of bringing API metadata into API hub from various sources. By creating plugin instances, you can seamlessly import API metadata from supported data sources directly into API hub.

Plugin instance

A plugin instance represents a configured and active connection between API hub and a specific API data source. It stores the unique configuration details required to connect to that data source, including connection credentials, curation settings, and any data import schedule. Each plugin instance serves as the entry point for collecting API metadata from its designated source, and each plugin instance can be configured to import data from runtime projects attached to API hub.

For more information about creating and managing plugin instances, see Manage plugin instances.

Limitations

The following limitations apply to plugins:

  • API hub currently doesn't support the creation of multiple plugin instances for the Apigee X and hybrid plugin.
  • You can't edit the plugin instance once it's created.

    If you need to modify the configuration of a plugin instance, you must delete the existing plugin instance and create a new one.

  • Deleting a plugin instance doesn't delete the associated data ingested into API hub. You must delete the associated data manually.

What's next