To use Apigee hybrid, you must (unless otherwise noted) enable the following
service APIs:
Task
Description
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).
Use gcloud to enable the required APIs as explained in the following steps. If you prefer,
you can use the Cloud Console to enable the APIs.
Complete the Prerequisites,
and be sure you have the gcloud CLI installed in your local shell:
gcloud -h
Create a PROJECT_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, see Locate the project ID:
export PROJECT_ID=YOUR_PROJECT_ID
Select the tab for your intended installation to see the command to enable the APIs:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-29 UTC."],[[["\u003cp\u003eThis documentation pertains to Apigee hybrid version 1.8, which is end-of-life, and users should upgrade to a newer version.\u003c/p\u003e\n"],["\u003cp\u003eTo use Apigee hybrid, specific service APIs like Apigee API, Apigee Connect API, and Cloud Pub/Sub API must be enabled.\u003c/p\u003e\n"],["\u003cp\u003eThe required APIs to enable vary depending on the platform used, whether it be GKE, OpenShift on Google Cloud, or other Kubernetes platforms.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003egcloud\u003c/code\u003e CLI or the Cloud Console can be used to enable the necessary service APIs for Apigee hybrid.\u003c/p\u003e\n"],["\u003cp\u003eAfter enabling all the required APIs, you must verify that all required APIs have been enabled by listing the services, using the \u003ccode\u003egcloud services list\u003c/code\u003e command.\u003c/p\u003e\n"]]],[],null,["# Step 1: Enable APIs\n\n| 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, see [Supported versions](/apigee/docs/hybrid/supported-platforms#supported-versions).\n\nTo use Apigee hybrid, you must (unless otherwise noted) enable the following\n[service APIs](/service-usage/docs/enable-disable):\n\n\nUse `gcloud` to enable the required APIs as explained in the following steps. If you prefer,\nyou can use the [Cloud Console](/endpoints/docs/openapi/enable-api) to enable the APIs.\n| **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.\n\n1. Complete the [Prerequisites](/apigee/docs/hybrid/v1.8/prerequisites), and be sure you have the [gcloud CLI](/sdk/docs/install) installed in your local shell: \n\n gcloud -h\n\n2. Create a `PROJECT_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, see [Locate the project ID](https://support.google.com/googleapi/answer/7014113): \n\n ```\n export PROJECT_ID=YOUR_PROJECT_ID\n ```\n | **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.\n3. Select the tab for your intended installation to see the command to enable the APIs:\n\n ### GKE\n\n\n If you will be running your clusters in Google Cloud (GKE), enable the APIs with the\n following command: \n\n ```\n gcloud services enable \\\n apigee.googleapis.com \\\n apigeeconnect.googleapis.com \\\n cloudresourcemanager.googleapis.com \\\n compute.googleapis.com \\\n container.googleapis.com \\\n pubsub.googleapis.com --project $PROJECT_ID\n ```\n\n ### OpenShift on Google Cloud\n\n\n If you will be running your clusters on OpenShift *on Google Cloud*, enable these\n APIs with the following command: \n\n ```\n gcloud services enable \\\n apigee.googleapis.com \\\n apigeeconnect.googleapis.com \\\n cloudapis.googleapis.com \\\n cloudresourcemanager.googleapis.com \\\n compute.googleapis.com \\\n dns.googleapis.com \\\n iam.googleapis.com \\\n iamcredentials.googleapis.com \\\n pubsub.googleapis.com --project $PROJECT_ID\n servicemanagement.googleapis.com \\\n serviceusage.googleapis.com \\\n storage-api.googleapis.com \\\n storage-component.googleapis.com --project $PROJECT_ID\n ```\n\n ### Other Platforms\n\n\n Enable the APIs with the following command if you will be running your clusters in\n another Kubernetes platform, such as\n - GKE on-prem\n - Anthos on bare metal\n - AKS\n - GKE on AWS\n - EKS\n\n ```\n gcloud services enable \\\n apigee.googleapis.com \\\n apigeeconnect.googleapis.com \\\n cloudresourcemanager.googleapis.com \\\n pubsub.googleapis.com --project $PROJECT_ID\n ```\n4. Verify that all APIs are enabled, using the following command: \n\n ```\n gcloud services list --project $PROJECT_ID\n ```\n\n\n The output should include all the APIs you just enabled, as in this example: \n\n ```verilog\n NAME TITLE\n apigee.googleapis.com Apigee API\n apigeeconnect.googleapis.com Apigee Connect API\n bigquery.googleapis.com BigQuery API\n bigquery.googleapis.com BigQuery API\n bigquerystorage.googleapis.com BigQuery Storage API\n cloudapis.googleapis.com Google Cloud APIs\n clouddebugger.googleapis.com Cloud Debugger API\n cloudresourcemanager.googleapis.com Cloud Resource Manager API\n cloudtrace.googleapis.com Cloud Trace API\n compute.googleapis.com Compute Engine API\n container.googleapis.com Kubernetes Engine API\n containeranalysis.googleapis.com Container Analysis API\n containerregistry.googleapis.com Container Registry API\n datastore.googleapis.com Cloud Datastore API\n iam.googleapis.com Identity and Access Management (IAM) API\n iamcredentials.googleapis.com IAM Service Account Credentials API\n logging.googleapis.com Cloud Logging API\n monitoring.googleapis.com Cloud Monitoring API\n oslogin.googleapis.com Cloud OS Login API\n pubsub.googleapis.com Cloud Pub/Sub API\n servicemanagement.googleapis.com Service Management API\n serviceusage.googleapis.com Service Usage API\n sql-component.googleapis.com Cloud SQL\n storage-api.googleapis.com Google Cloud Storage JSON API\n storage-component.googleapis.com Cloud Storage\n ```\n\nNext step\n---------\n\n\nGo to Step 2: [Create an organization](/apigee/docs/hybrid/v1.8/precog-provision)."]]
