Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Esta página
se aplica à Apigee e à Apigee híbrida.
É possível registrar proxies implantados presentes nos projetos de ambiente de execução da Apigee
e da Apigee híbrida diretamente no hub de API com um clique.
Figura 1. Faça o registro automático de APIs da Apigee e da Apigee híbrida.
Os proxies serão registrados como recursos de API no hub de API. Para registrar os proxies, anexe seu projeto de ambiente de execução ao
hub da API. Quando você anexa um projeto, o hub de API registra as seguintes informações para cada
definição de proxy:
Nome
Revisão
Detalhes do ambiente e da implantação
Tipo de instância da Apigee (Apigee X ou Apigee híbrida)
O hub de APIs executa periodicamente (uma vez a cada seis horas) um programador que se conecta ao
projeto da Apigee e recebe as definições de proxy mais recentes. Para os projetos recém-anexados, o programador recebe todas as definições de proxy e as registra no hub da API.
Nos projetos atuais, o programador recebe apenas as mudanças feitas nas definições
de proxy e atualiza as informações do proxy no hub da API.
Anexar um projeto de ambiente de execução
Para anexar um projeto de ambiente de execução da Apigee ao hub de API, siga estas etapas:
No console do Google Cloud, acesse a página Hub de API > Configurações > Associações de projetos.
Clique em Anexar projeto de ambiente de execução. O painel Selecionar um recurso vai aparecer.
Clique no projeto do Google Cloud em que a Apigee está instalada. Se não houver erros, o projeto será anexado ao hub da API e
será listado na página Associações de projetos. No entanto, o processo real de
registro dos proxies começará após a próxima execução do programador.
Remover um projeto de ambiente de execução
Se você remover um projeto de ambiente de execução, o hub de API removerá todas as APIs registradas para esse projeto.
Para remover um projeto do ambiente de execução da Apigee do hub de APIs, siga estas etapas:
No console do Google Cloud, acesse a página Hub de API > Configurações > Associações de projetos.
Clique em Desanexar projeto referente ao projeto que você quer desanexar.
Considerações
Considere o seguinte ao tentar registrar automaticamente as APIs:
Todos os endpoints importados da Apigee vão receber um prefixo https:// por padrão.
Proxies que não são implantados em nenhum ambiente não são buscados no projeto.
Somente proxies implantados em um ambiente são buscados. Além disso, o ambiente precisa fazer parte
de um grupo de ambientes.
O hub de API não é compatível com o VPC Service Controls. Portanto, se você tiver ativado o VPC Service Controls para seu projeto de ambiente de execução da Apigee,
o hub da API não poderá acessar o projeto.
Se a API Apigee não estiver ativada para um projeto de ambiente de execução, o hub da API não vai poder acessar o projeto.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-08-07 UTC."],[[["\u003cp\u003eAPI proxies from Apigee and Apigee hybrid can be automatically registered in API hub by attaching the respective runtime project.\u003c/p\u003e\n"],["\u003cp\u003eAPI hub's scheduler periodically retrieves and registers new or updated proxy definitions from attached Apigee projects, running once every six hours.\u003c/p\u003e\n"],["\u003cp\u003eAttaching a runtime project to API hub requires selecting the Google Cloud project where Apigee is installed in the "Project associations" page.\u003c/p\u003e\n"],["\u003cp\u003eDetaching a runtime project from API hub removes all registered APIs associated with that project, though created attributes are retained.\u003c/p\u003e\n"],["\u003cp\u003eOnly proxies deployed in environments that are part of an environment group are fetched, and VPC Service Controls is not supported by API hub.\u003c/p\u003e\n"]]],[],null,["# Auto-register Apigee proxies\n\n*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\n\nThis page describes how to automatically register Apigee proxies in API hub. API hub lets you to register deployed proxies from both Apigee and Apigee hybrid runtime projects directly into API hub. This auto-registration process enables API hub to register API resources from multiple API gateways.\n\nHow auto-registration works\n---------------------------\n\n\nWhen 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 hybrid) is automatically registered.\n**Figure 1.** Auto-register APIs from Apigee and Apigee hybrid.\n\n### Project associations and plugins\n\n| **Deprecated:** [Pull-based](/apigee/docs/apihub/plugins#plugin-data-ingestion-methods) ingestion is no longer supported for Apigee and Apigee hybrid plugins as of **July 31, 2025** . For existing projects that have pull-based Apigee and hybrid plugins configured, these plugins will continue to function and will be automatically migrated to the push-based type starting **August, 2025**.\n\nWhen 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 hybrid plugin instance by default in API hub and ingests any deployed API proxies from Apigee.\n| **Note:**If you provision API hub directly from the API hub UI, API hub doesn't automatically create a default plugin instance, nor does it auto-register proxies.\n\n\nIf you manually attach any additional Apigee runtime projects (Apigee or Apigee hybrid), 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.\n\n### Project associations scheduler\n\n| **Note:** This functionality applies only to [pull-based](/apigee/docs/apihub/plugins#plugin-data-ingestion-methods) Apigee and hybrid plugin instances. For push-based plugins, data ingestion is automatically triggered by changes in the source.\n\nAPI hub periodically (once in six hours) runs a scheduler that connects to your\nApigee project, and gets the latest proxy definitions. For the projects that are newly\nattached, the scheduler gets all the proxy definitions, and then registers them in API hub.\nAnd for the existing projects, the scheduler gets only the changes made to the proxy\ndefinitions, and then accordingly updates the proxy information in API hub.\n\nAttach a runtime project\n------------------------\n\n### Before you begin\n\n- If you are attaching an Apigee runtime project, ensure that your Apigee organization doesn't have [Data Residency (DRZ) enabled](/apigee/docs/api-platform/get-started/drz-concepts). API hub doesn't support creating a plugin instance if Data Residency is enabled for your Apigee organization.\n- Grant the [Cloud API hub Runtime Project Attachment Editor (`roles/apihub.runTimeProjectAttachmentsEditor`)](/iam/docs/roles-permissions/apihub#apihub.runTimeProjectAttachmentsEditor) IAM role to your principal account.\n\nTo attach an runtime project to API hub, do the following steps:\n\n1. In the Google Cloud console, go to the **API hub** page.\n\n [Go to API hub](https://console.cloud.google.com/apigee/api-hub)\n2. Click settings **Settings** from the left navigation menu to open the **Settings** page.\n3. Go to the **Project associations** tab and click **Attach runtime project** . This displays the **Select a resource** pane.\n4. Click the Google Cloud project where your runtime project is provisioned.\n5. 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.\n6. Click **Attach**.\n\nEdit project association settings\n---------------------------------\n\nYou 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:\n\n1. In the Google Cloud console, go to the **API hub** page.\n\n [Go to API hub](https://console.cloud.google.com/apigee/api-hub)\n2. Click settings **Settings** from the left navigation menu to open the **Settings** page.\n3. Go to the **Project associations** tab to view the list of attached projects.\n4. Click **Edit settings** for the desired project.\n5. In the **Project association settings** pane, edit the **API assets to automatically import** checkbox selection.\n6. Click **Save** to apply your changes.\n\nDetach a runtime project\n------------------------\n\n| **Warning:**Detaching a runtime project from API hub also deletes all the associated plugin instances and registered APIs from API hub.\n\nTo detach a runtime project from API hub, do the following steps:\n\n1. In the Google Cloud console, go to the **API hub** page.\n\n [Go to API hub](https://console.cloud.google.com/apigee/api-hub)\n2. Click settings **Settings** from the left navigation menu to open the **Settings** page.\n3. Go to the **Project associations** tab to view the list of attached projects.\n4. Click **Detach project** for the project you want to detach.\n\n| **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.\n\nConsiderations\n--------------\n\nConsider the following when attempting to attach Apigee runtime projects:\n\n- All endpoints imported from Apigee will be given an `https://` prefix by default.\n- Proxies that aren't deployed in any environment, aren't fetched from the project.\n- Only proxies that are deployed in an environment are fetched. And the environment must be a part of an environment group.\n- Additional attributes representing the Apigee instance type (`Apigee X and Hybrid Environment` and `Apigee X and Hybrid Organization`) are automatically created and added to any proxy API deployments that are imported. **Deprecated:** The Apigee instance type attribute is no longer added to API deployments as of **July 31, 2025** . For existing projects that have Apigee instance type attributes configured, we recommend that you remove these attributes from any filtered search queries. You can use the **Source project** and **Source environment** fields instead.\n- API hub doesn't support [VPC Service Controls](/vpc-service-controls/docs/overview). Hence, if you have enabled VPC Service Control for your Apigee runtime project, API hub can't access the project.\n- If the Apigee API isn't enabled for a runtime project, API hub can't auto-register or import the API proxies.\n\n### Limitations\n\n- API hub doesn't support creating a plugin instance if [Data Residency (DRZ) is enabled](/apigee/docs/api-platform/get-started/drz-concepts) for your Apigee organization.\n\nWhat's next\n-----------\n\n- Learn more about [plugins and plugin instances](/apigee/docs/apihub/plugins).\n- Learn about [curations](/apigee/docs/apihub/curations)."]]
