This page applies to Apigee and Apigee hybrid.
This page describes how to automatically register Apigee proxies in API hub. API hub lets you to register deployed proxies from both Apigee and Apigee hydrid runtime projects directly into API hub. This auto-registration process enables API hub to register API resources from multiple API gateways.
How auto-registration works
When you attach an Apigee runtime project to API hub, information such as the proxy's name, environment and deployment details, and the type of Apigee instance (Apigee or Apigee hydrid) is automatically registered.
Project associations and plugins
When you provision API hub as part of Apigee provisioning, it automatically identifies and attaches any associated Apigee runtime projects. This automatically creates an Apigee and hydrid plugin instance by default in API hub and ingests any deployed API proxies from Apigee.
If you manually attach any additional Apigee runtime projects (Apigee or Apigee hydrid), API hub offers an option to import additonal API metadata. When this option is selected, API hub automatically creates the necessary plugin instance to manage the metadata import. These plugin instances are key to managing the connection and data ingestion for the auto-registration process.
API hub periodically (once in six hours) runs a scheduler that connects to your Apigee project, and gets the latest proxy definitions. For the projects that are newly attached, the scheduler gets all the proxy definitions, and then registers them in API hub. And for the existing projects, the scheduler gets only the changes made to the proxy definitions, and then accordingly updates the proxy information in API hub.
Attach a runtime project
To attach an Apigee runtime project to API hub, do 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.
- Go to the Project associations tab and click Attach runtime project. This displays the Select a resource pane.
- Click the Google Cloud project where the Apigee instance is installed.
- In the Project association settings pane, select the API assets to automatically import checkbox.
- Click Attach.
Edit project association settings
You can edit the project association settings to change the API assets which are automatically imported. To edit the project association settings, do 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.
- Go to the Project associations tab to view the list of attached projects.
- Click Edit settings for the desired project.
- In the Project association settings pane, edit the API assets to automatically import checkbox selection.
- Click Save to apply your changes.
Detach a runtime project
To detach an Apigee runtime project from API hub, do 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.
- Go to the Project associations tab to view the list of attached projects.
- Click Detach project for the project you want to detach.
Considerations
Consider the following when attempting to auto-register APIs:
- All endpoints imported from Apigee will be given an
https://prefix by default. - Proxies that aren't deployed in any environment, aren't fetched from the project.
- Only proxies that are deployed in an environment are fetched. And the environment must be a part of an environment group.
- API hub doesn't support VPC Service Controls. Hence, if you have enabled VPC Service Control for your Apigee runtime project, API hub can't access the project.
- If the Apigee API isn't enabled for a runtime project, API hub can't auto-register or import the API proxies.
What's next
- Learn more about plugins and plugin instances.
- Learn about curations.