Using data residency with Apigee hybrid Stay organized with collections Save and categorize content based on your preferences.
This topic explains how to configure a new Apigee hybrid installation for data residencycompliance.
About data residency
You can use data residency with new Apigee hybrid installations. You cannot convert an existing installation to use data residency.
Data residency meets compliance and regulatory requirements by allowing you to specify the geographic locations (regions) where Apigee data is stored. With data residency, selecting the control plane location ensures that all customer content is stored within the specified region. See also, seeIntroduction to data residency.
Basic steps for data residency configuration
To configure Apigee hybrid for data residency, you need to follow a few basic steps, including:
- Creating an Apigee organization with data residency
- Creating an environment using the Apigee API
- Enabling the new data pipeline
- Configuring the overrides file(s)
Creating an Apigee organization with data residency
When you create an Apigee organization, you have the option of enabling the org withdata residency. Creating an org with data residency requires you to specify twokey location attributes: thecontrol plane location and theconsumer data region.You will also need to specify thebilling type. For details, seeStep 2: Create an organization.
- Control plane location: You need to specify the location where customer core content like proxy bundles are stored. For a list seeAvailable Apigee API control plane regions.
The control plane location is the location of the service endpoint location, for example
usfor United States.The following table lists available hosting jurisdictions and regions for the Apigee control plane.
Americas
Control plane hosting jurisdiction description Control plane hosting jurisdiction name Details United States us (multiple regions in United States)Service endpoint: us-apigee.googleapis.comCanada ca (multiple regions in Canada)Service endpoint: ca-apigee.googleapis.comConsumer data region description Consumer data region name Details Iowa us-central1Low CO2
Oregon us-west1Low CO2
Los Angeles us-west2Salt Lake City us-west3Las Vegas us-west4South Carolina us-east1Northern Virginia us-east4Columbus us-east5Dallas us-south1Montréal northamerica-northeast1Low CO2
Toronto northamerica-northeast2Low CO2
Europe
Control plane hosting jurisdiction description Control plane hosting jurisdiction name Details European Union eu (multiple regions in the European Union)Service endpoint: eu-apigee.googleapis.comGermany de (multiple regions in Germany)Service endpoint: de-apigee.googleapis.comFrance fr (single region europe-west9)Service endpoint: fr-apigee.googleapis.comSwitzerland ch (single region europe-west6)Service endpoint: ch-apigee.googleapis.comConsumer data region description Consumer data region name Details Belgium europe-west1Low CO2
Frankfurt europe-west3Netherlands europe-west4Zurich europe-west6Low CO2
Milan europe-west8Paris europe-west9Low CO2
Turin europe-west12Warsaw europe-central2Madrid europe-southwest1Low CO2
Finland europe-north1Low CO2
Asia-Pacific
Control plane hosting jurisdiction description Control plane hosting jurisdiction name Details Australia au (multiple regions in Australia)Service endpoint: au-apigee.googleapis.comIndia in (multiple regions in India)Service endpoint: in-apigee.googleapis.comJapan jp (multiple regions in Japan)Service endpoint: jp-apigee.googleapis.comConsumer data region description Consumer data region name Details Sydney australia-southeast1Melbourne australia-southeast2Mumbai asia-south1Delhi asia-south2Tokyo asia-northeast1Osaka asia-northeast2Middle East
Control plane hosting juridiction description Control plane hosting jurisdiction name Details Qatar qa (single region me-central1)Service endpoint: qa-apigee.googleapis.comSaudi Arabia sa (single region me-central2)Service endpoint: sa-apigee.googleapis.comIsrael il (single region me-west1)Service endpoint: il-apigee.googleapis.comConsumer data region description Consumer data region name Details Doha me-central1Dammam me-central2Tel Aviv me-west1 - Consumer data region: You need to specify a region where API consumer data is stored. This must be a sub-region of the control plane region. For a list of available consumer data regions, see Apigee locations.
- Billing type: You can only use data residency with paid subscription orgs.
Creating an environment using the Apigee API
If you create a new environment using the Apigee API, you must specify thecontrol plane location. SeeCreate an environment.If you use the UI to create an environment, no special steps are needed.
Configure the control planecontractProvider
Add thecontractProvider configuration property to each overrides file and apply the changes. The service endpoint for Apigee management APIs. For example:https://us-apigee.googleapis.com.
For example:
instanceID: "my_hybrid_example"namespace: apigeegcp: projectID: hybrid-example region: us-central1k8sCluster: name: apigee-hybrid region: us-central1org: hybrid-examplecontractProvider: https://us-apigee.googleapis.com
SeeStep 7: Create the overrides
When calling the Apigee APIs
When you makecurl calls to Apigee APIs to perform tasks in your hybrid installation, you will need to call APIs from within the control plane location:
curl -H "Authorization: Bearer $TOKEN" \ "https://CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/ORG_NAME/envgroups"
For example:
curl -H "Authorization: Bearer $TOKEN" \ "https://us-apigee.googleapis.com/v1/organizations/my-hybrid-org/envgroups"
URL allowlisting
If you are using forward proxies with data residency, you must additionally allowlist in the forward proxy:
CONTROL_PLANE_LOCATION-apigee.googleapis.comANALYTICS_REGION-pubsub.googleapis.com- URLs required by Apigee hybrid, seeGoogle Cloud URLs to allow for Hybrid.
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-18 UTC.