Step 1: Enable APIs

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.

Apigee hybrid requires certainGoogle Cloud service APIs. In this step, you will enable the APIs that are required for your installation platform.

Usegcloud to enable the required APIs as explained in the following steps. If you prefer, you can use theGoogle Cloud console to enable the APIs.

Note:The Apigee hybrid installation steps are written for the Linux/UNIX/Mac command shell. If you are using Windows, substitute the equivalent Windows command line syntax.
  1. Complete thePrerequisites, and be sure you have thegcloud CLI installed in your local shell:
    gcloud --help
  2. Create aPROJECT_ID environment variable where the value is the ID of the Google Cloud project you plan to use for Apigee hybrid. A project ID is a unique string used to differentiate your project from all others in Google Cloud. If needed, seeLocate the project ID:
    export PROJECT_ID=YOUR_PROJECT_ID
    Note: Be sure the project ID is correct. This variable is used throughout the hybrid installation instructions. Do not include a period after the project ID.
  3. Select the tab for your intended installation to see the command to enable the APIs:

    GKE on Google Cloud

    If you will be running your clusters on Google Kubernetes Engine (GKE), run this command to enable the required APIs:

    Click to see details on the APIs

    NameTitleDescription
    apigee.googleapis.com Apigee API Provides communication between your project and other hybrid services and Google Cloud APIs.
    apigeeconnect.googleapis.com Apigee Connect API Provides communication between the Apigee management plane and the runtime plane.
    pubsub.googleapis.com Cloud Pub/Sub API Required for the Apigee quota feature to operate.
    cloudresourcemanager.googleapis.com Cloud Resource Manager API Used by hybrid to validate service accounts.
    container.googleapis.com Kubernetes Engine API Enable if you plan to use Google Kubernetes Engine (GKE) on Google Cloud or software-only Google Distributed Cloud for your hybrid runtime installation.
    compute.googleapis.com Compute Engine API Used for cluster management (GKE-based and OpenShift-based clusters only).
    gcloud services enable \    apigee.googleapis.com \    apigeeconnect.googleapis.com \    cloudresourcemanager.googleapis.com \    compute.googleapis.com \    container.googleapis.com \    pubsub.googleapis.com --project$PROJECT_ID

    Other Platforms

    If you will be running your clusters on one of the following platforms run the command below to enable the required APIs:

    • AKS
    • EKS
    • GKE on AWS
    • OpenShift
    • Software-only Google Distributed Cloud on VMware or bare metal

    Click to see details on the APIs

    NameTitleDescription
    apigee.googleapis.com Apigee API Provides communication between your project and other hybrid services and Google Cloud APIs.
    apigeeconnect.googleapis.com Apigee Connect API Provides communication between the Apigee management plane and the runtime plane.
    monitoring.googleapis.com Cloud Monitoring API Required for access to Cloud Monitoring metrics.
    pubsub.googleapis.com Cloud Pub/Sub API Required for the Apigee quota feature to operate.
    cloudresourcemanager.googleapis.com Cloud Resource Manager API Used by hybrid to validate service accounts.
    gcloud services enable \    apigee.googleapis.com \    apigeeconnect.googleapis.com \    cloudresourcemanager.googleapis.com \    monitoring.googleapis.com \    pubsub.googleapis.com  --project$PROJECT_ID
  4. (Optional) To verify that the required APIs are enabled, execute this command. If the required APIs are in the returned list, then they are enabled.
    gcloud services list --project$PROJECT_ID

Next step

Go to Step 2:Create an organization.

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.