Apigee Connect

You are currently viewing version 1.13 of the Apigee hybrid documentation.This version is end of life. You should upgrade to a newer version. For more information, seeSupported versions.

This section describes using Apigee Connect for communication between the hybrid management plane and the MART service in the runtime plane.

Introduction

Apigee Connect allows the Apigee hybrid management plane to connect securely to the MART service in the runtime plane without requiring you to expose the MART endpoint on the internet. If you use Apigee Connect, you do not need to configure the MART ingress gateway with a host alias and an authorized DNS certificate.

Primary services that execute on the hybrid runtime plane showing Apigee Connect

Configuring Apigee connect

Configure Apigee connect in your overrides with theconnectAgent configuration property.

Service account

Apigee connect uses theapigee-mart service account. This service account requires the Apigee Connect Agentroles/apigeeconnect.Agent role. SeeService accounts and roles used by hybrid components.

Use theconnectAgent.serviceAccountPath orconnectAgent.serviceAccountRef configuration properties to specify theapigee-mart service account key. Alternatively you canstore the service account key in Hashicorp Vault.

API

Apigee Connect requires theApigee Connect API in theGoogle Cloud API Library. For instructions on enabling APIs in the Google Cloud console, seeStep 3: Enable APIs.

Applying Apigee connect configuration

Apply changes to the Apigee connect configuration with theapigee-org chart with the following command:

helm upgradeORG_NAME apigee-org/ \  --namespaceapigee \  --atomic \  -fOVERRIDES_FILE.yaml
Note: If you see an error sayingError: UPGRADE FAILED: "ORG_NAME" has no deployed releases, replaceupgrade withinstall and try the command again.

Image

Apigee connect uses thegcr.io/apigee-release/hybrid/apigee-connect-agent:1.13.4 image. If you want to use a private image repository, seeUse a private image repository with Apigee hybrid.

Checking Apigee connect logs

Check the Apigee Connect Agent log.

kubectl logs -nnamespaceapigee-connect-agent-pod-name

The Apigee Connect Agent reports the following log categories:
Audit logs categoryOperations
DATA_READConnectionService.ListConnections
DATA_WRITETether.Egress
For help on viewing audit logs in Apigee hybrid see Audit logging information.

You can set the level of logging with theconnectAgent.logLevel configuration property.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-19 UTC.