Manage project associations in API hub

This page applies to Apigee and Apigee hybrid.

This page describes how to attach, edit, and detach project associations in API hub. Project associations enable you to automatically register APIs from Google Cloud services to API hub.

Attach a runtime project to API hub

Attaching a runtime project to API hub establishes a project association between the Google Cloud project and API hub. This association enables API hub to automatically register APIs from the project and keep them synchronized.

Before you begin

• Ensure that the data residency status (enabled or disabled) of the attached Apigee runtime project matches the data residency status of the Apigee organization associated with your API hub host project.
• Grant the Cloud API hub Runtime Project Attachment Editor (roles/apihub.runTimeProjectAttachmentsEditor) IAM role to your principal account.
Note: The roles/apihub.runTimeProjectAttachmentsEditor role on the runtime project provides sufficient permission to attach the project to API hub and authorize data ingestion from all supported services (for example, Apigee and API Gateway). This permission allows data ingestion even if the user does not have specific administrative roles (such as roles/apigee.admin or roles/apigateway.admin) for those services in the runtime project.

Console

To attach an runtime project to API hub, do 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. Go to the Project associations tab and click Attach runtime project. This displays the Select a resource pane.
4. Click the Google Cloud project where your runtime project is provisioned.
5. In the Project association settings pane, select the API assets to automatically import checkbox.
   Note: API hub automatically creates a plugin instance for the associated runtime project if you choose to import assets. This plugin instance is displayed in the Associated plugins column on the Project associations page.
6. Click Attach.

REST

To attach a runtime project to API hub, use the create method.

curl -X POST   
-H "Authorization: Bearer $(gcloud auth print-access-token)"   
-H "Content-Type: application/json"
  -d '{
    "runtime_project": "RUNTIME_PROJECT_ID"
  }'   "https://apihub.googleapis.com/v1/projects/HUB_PROJECT_ID/locations/LOCATION/runtimeProjectAttachments?runtime_project_attachment_id=RUNTIME_PROJECT_ID"

Replace the following:

• HUB_PROJECT_ID: The project ID of your API hub host project.
• LOCATION: The location of your API hub host project.
• RUNTIME_PROJECT_ID: The Google Cloud project name or ID that you want to attach to API hub.

Edit project association settings

You can edit the project association settings to change the API assets which are imported to API hub.

Console

To edit the project association settings, do 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. Go to the Project associations tab to view the list of attached projects.
4. Click Edit settings for the desired project.
5. In the Project association settings pane, edit the API assets to automatically import checkbox selection.
6. Click Save to apply your changes.

Detach a runtime project from API hub

Warning: Detaching a runtime project from API hub also deletes all the associated plugin instances and registered APIs from API hub.

Console

To detach a runtime project from API hub, do 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. Go to the Project associations tab to view the list of attached projects.
4. 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.

REST

To detach a runtime project from API hub, use the delete method.

curl -X DELETE   -H "Authorization: Bearer $(gcloud auth print-access-token)"
"https://apihub.googleapis.com/v1/projects/HUB_PROJECT_ID/locations/LOCATION/runtimeProjectAttachments/RUNTIME_PROJECT_ID"

Replace the following:

• HUB_PROJECT_ID: The project ID of your API hub host project.
• LOCATION: The location of your API hub host project.
• RUNTIME_PROJECT_ID: The Google Cloud project name or ID that you want to detach from API hub.