Step 3: Enable APIs

You are currently viewing version 1.6 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 enable the following APIs for the project in the Google Cloud console:

  • 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 MART service in the runtime plane.
  • Cloud Pub/Sub API: Required for quota to operate.
  • Cloud Resource Manager API: Used by hybrid to validate service accounts.
  • Compute Engine API: Used for cluster management (GKE-based clusters only).
  • Kubernetes Engine API: Enable if you plan to use Google Kubernetes Engine (GKE), or GKE on-prem (Anthos) on-prem for your hybrid runtime installation.

Enable the required APIs for your Google Cloud project:

You can use the CLI or the Google Cloud console UI to enable the APIs.

Google Cloud UI

To enable the APIs using the UI, perform the following steps:

  1. Open theGoogle Cloud console API Library and log in with the account you created inStep 1: Create a Google Cloud account.
  2. Select the project that you created inStep 2: Create a Google Cloud project.
  3. Enable theApigee API as follows:
    1. If you do not see theAPI Library page, selectAPIs & Services > Library from theNavigation menu.

      Navigation menu highlighted

    2. Make sure the correct project is selected.

      Google Cloud Platform project selector

    3. In theAPI Library view search for "Apigee".

      API library search box

      Google Cloud displays a list of APIs matching "Apigee"

    4. Locate theApigee API service and click it.

      5. Apigee API service option

    5. In the Apigee API view clickEnable.

      Google Cloud enables theApigee API for your Google Cloud project.

  4. Enable theApigee Connect API:
    1. In theAPI Library view, search for "Apigee Connect".
    2. Locate theApigee Connect API and enable it.
  5. Enable theCloud Pub/Sub API:
    1. In theAPI Library view, search for "Cloud Pub/Sub API".
    2. Locate theCloud Pub/Sub API and enable it.
  6. Enable theCloud Resource Manager API:
    1. In theAPI Library view, search for "Cloud Resource Manager".
    2. Locate theCloud Resource Manager and enable it.
  7. (GKE-based clusters only) Enable theCompute Engine API:
    1. In theAPI Library view, search for "Compute Engine".
    2. Locate theCompute Engine API and enable it.
  8. (GKE-based clusters only) Enable theGoogle Kubernetes Engine API:
    1. In theAPI Library view, search for "Google Kubernetes Engine".
    2. Locate theGoogle Kubernetes API and enable it.
  9. To confirm that you have enabled the APIs, selectAPIs & Services > Dashboard.

    The APIs you just added are displayed in the list of enabled APIs:

    • Apigee API
    • Apigee Connect API
    • Cloud Pub/Sub API
    • Cloud Resource Manager API
    • Compute Engine API
    • Kubernetes Engine API

gcloud CLI

To enable the APIs using the CLI, perform the following steps:

  1. Open a terminal window on the device you are using to manage Apigee.
  2. Be sure you havegcloud installed in your local shell by running the following command. Thegcloud tool provides the primary command-line interface for Cloud.
    gcloud -h

    If you do not havegcloud installed,install the Cloud SDK.

  3. Make sure you have thePROJECT_ID variable defined with the ID of the project you created inStep 2: Create a Google Cloud project:
    echo $PROJECT_ID

    If it is not, define thePROJECT_ID environment variable with the following command:

    export PROJECT_ID=your_project_id
    Note: Do not include the period after the project ID.
    Project ID name with trailing period
  4. 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

    GKE on-prem

    If you will be running your clusters in GKE on-prem (Anthos), enable the APIs with the following command:

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

    Anthos on bare metal

    If you will be running Apigee hybrid in Anthos clusters bare metal, enable the APIs with the following command:

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

    AKS

    If you will be running your clusters in Azure Kubernetes Service (AKS), enable the APIs with the following command:

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

    GKE on AWS

    If you will be running your clusters in GKE on AWS, enable the APIs with the following command:

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

    EKS

    If you will be running your clusters in Amazon EKS, enable the APIs with the following command:

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

    OpenShift

    If you will be running Apigee hybrid in a conformant Kubernetes cluster on OpenShift, enable the APIs with the following command:

    gcloud services enable \    apigee.googleapis.com \    apigeeconnect.googleapis.com \    cloudresourcemanager.googleapis.com \    pubsub.googleapis.com  --project $PROJECT_ID
  5. Verify that all APIs are enabled using the following command:
    gcloud services list

    The following is returned:

    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

For more information about enabling APIs in the Google Cloud console, seeEnabling an API in your Google Cloud project in the Cloud documentation.

123(NEXT) Step 4: Create an organization5

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.