Auto-register Apigee proxies

This page applies to Apigee and Apigee hybrid.

You can register deployed proxies present in your Apigee and Apigee hybrid runtime projects directly in API hub with the click of a button.

Figure 1. Auto-register APIs from Apigee and Apigee hybrid.

The proxies will be registered as API resources in API hub. To register the proxies, you must attach your runtime project to API hub. When you attach a project, API hub registers the following information for each proxy definition:

• Name
• Revision
• Environment and deployment details
• Type of Apigee instance (either Apigee X or Apigee hybrid)

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.

Note: For a newly attached project, for API hub to register all the proxy definitions, you must wait till the next run of the scheduler.

Attach a runtime project

To attach an Apigee runtime project to API hub, do the following steps:

1. In the Google Cloud console, go to the API hub > Settings > Project associations page.

2. Click Attach runtime project. This displays the Select a resource pane.
3. Click the Google Cloud project where Apigee is installed. If there aren't any errors, the project gets attached to API hub, and will be listed in the Project associations page. However, the actual process of registering the proxies will start after the next run of the scheduler.

Note: If you have provisioned API hub in a project that has Apigee proxies, such proxies are automatically registered in API hub within a few hours after provisioning API hub. For example, if you are provisioning API hub in test-project-1, and this project has Apigee proxies, the test-project-1 is automatically attached as a runtime project, and the proxies in the test-project-1 are registered in API hub.

Detach a runtime project

If you detach a runtime project, API hub removes all the APIs registered for that project. To detach an Apigee runtime project from API hub, do the following steps:

1. In the Google Cloud console, go to the API hub > Settings > Project associations page.

2. Click Detach project for the project you want to detach.

Note: Even though all the APIs of the detached project are removed from API hub, the attributes that were created for those APIs aren't deleted, and will still show up in API hub.

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 access the project.