Step 1: Enable APIs

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

To use Apigee hybrid, you must (unless otherwise noted) enable the followingservice APIs:

TaskDescription
Apigee API Provides communication between your project and other hybrid services and Google Cloud APIs.
Apigee Connect API Provides communication between the Apigee management plane and the runtime plane.
Cloud Pub/Sub API Required for the Apigee quota feature to operate.
Cloud Resource Manager API Used by hybrid to validate service accounts.
Kubernetes Engine API Enable if you plan to use Google Kubernetes Engine (GKE), or GKE on-prem (Anthos) for your hybrid runtime installation.
Compute Engine API Used for cluster management (GKE-based and OpenShift on Google Cloud-based clusters only).
Google Cloud APIs This is a meta service for Google Cloud APIs for convenience (OpenShift on Google Cloud-based clusters only).
Cloud DNS API Google Cloud DNS is a scalable, reliable, and managed authoritative Domain Name System (DNS) service running on the same infrastructure as Google. (OpenShift on Google Cloud-based clusters only).
Identity and Access Management (IAM) API Manages identity and access control for Google Cloud Platform resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. (OpenShift on Google Cloud-based clusters only).
IAM Service Account Credentials API Service Account Credentials API allows developers to create short-lived, limited-privilege credentials for their service accounts on Google Cloud. (OpenShift on Google Cloud-based clusters only).
Service Management API Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service consumers. (OpenShift on Google Cloud-based clusters only).
Service Usage API Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use. (OpenShift on Google Cloud-based clusters only).
Google Cloud Storage JSON API Lets you store and retrieve potentially-large, immutable data objects (OpenShift on Google Cloud-based clusters only).
Cloud Storage Google Cloud Storage is a RESTful service for storing and accessing your data on Google's infrastructure. (OpenShift on Google Cloud-based clusters only).

Usegcloud to enable the required APIs as explained in the following steps. If you prefer, you can use theCloud 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 -h
  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

    If you will be running your clusters in Google Cloud (GKE), enable the APIs with the following command:

    gcloud services enable \    apigee.googleapis.com \    apigeeconnect.googleapis.com \    cloudresourcemanager.googleapis.com \    compute.googleapis.com \    container.googleapis.com \    pubsub.googleapis.com --project$PROJECT_ID

    OpenShift on Google Cloud

    If you will be running your clusters on OpenShifton Google Cloud, enable these APIs with the following command:

    gcloud services enable \    apigee.googleapis.com \    apigeeconnect.googleapis.com \    cloudapis.googleapis.com \    cloudresourcemanager.googleapis.com \    compute.googleapis.com \    dns.googleapis.com \    iam.googleapis.com \    iamcredentials.googleapis.com \    pubsub.googleapis.com  --project $PROJECT_ID    servicemanagement.googleapis.com \    serviceusage.googleapis.com \    storage-api.googleapis.com \    storage-component.googleapis.com  --project $PROJECT_ID

    Other Platforms

    Enable the APIs with the following command if you will be running your clusters in another Kubernetes platform, such as

    • GKE on-prem
    • Anthos on bare metal
    • AKS
    • GKE on AWS
    • EKS
    gcloud services enable \    apigee.googleapis.com \    apigeeconnect.googleapis.com \    cloudresourcemanager.googleapis.com \    pubsub.googleapis.com  --project$PROJECT_ID
  4. Verify that all APIs are enabled, using the following command:
    gcloud services list --project$PROJECT_ID

    The output should include all the APIs you just enabled, as in this example:

    NAMETITLEapigee.googleapis.comApigeeAPIapigeeconnect.googleapis.comApigeeConnectAPIbigquery.googleapis.comBigQueryAPIbigquery.googleapis.comBigQueryAPIbigquerystorage.googleapis.comBigQueryStorageAPIcloudapis.googleapis.comGoogleCloudAPIsclouddebugger.googleapis.comCloudDebuggerAPIcloudresourcemanager.googleapis.comCloudResourceManagerAPIcloudtrace.googleapis.comCloudTraceAPIcompute.googleapis.comComputeEngineAPIcontainer.googleapis.comKubernetesEngineAPIcontaineranalysis.googleapis.comContainerAnalysisAPIcontainerregistry.googleapis.comContainerRegistryAPIdatastore.googleapis.comCloudDatastoreAPIiam.googleapis.comIdentityandAccessManagement(IAM)APIiamcredentials.googleapis.comIAMServiceAccountCredentialsAPIlogging.googleapis.comCloudLoggingAPImonitoring.googleapis.comCloudMonitoringAPIoslogin.googleapis.comCloudOSLoginAPIpubsub.googleapis.comCloudPub/SubAPIservicemanagement.googleapis.comServiceManagementAPIserviceusage.googleapis.comServiceUsageAPIsql-component.googleapis.comCloudSQLstorage-api.googleapis.comGoogleCloudStorageJSONAPIstorage-component.googleapis.comCloudStorage

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.