> [!CAUTION]
> You are currently viewing version 1.14 of the Apigee hybrid documentation. For more information, see [Supported versions](https://docs.cloud.google.com/apigee/docs/hybrid/supported-platforms.md.txt#supported-versions).

<button class="button button-with-icon cloud-select-dropdown__button button-primary" aria-haspopup="true">Version 1.14 </button>

- Supported versions:
- [v1.17 (latest)](https://docs.cloud.google.com/apigee/docs/hybrid/v1.17/using-data-residency-with-apigee-hybrid.md.txt)
- [v1.16](https://docs.cloud.google.com/apigee/docs/hybrid/v1.16/using-data-residency-with-apigee-hybrid.md.txt)
- [v1.15](https://docs.cloud.google.com/apigee/docs/hybrid/v1.15/using-data-residency-with-apigee-hybrid.md.txt)
- [v1.14](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/using-data-residency-with-apigee-hybrid.md.txt)
- [List of supported versions](https://docs.cloud.google.com/apigee/docs/hybrid/supported-platforms.md.txt#supported-versions)
- Unsupported versions:
- [v1.13](https://docs.cloud.google.com/apigee/docs/hybrid/v1.13/using-data-residency-with-apigee-hybrid.md.txt)
- [v1.12](https://docs.cloud.google.com/apigee/docs/hybrid/v1.12/using-data-residency-with-apigee-hybrid.md.txt)
- [v1.11](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/using-data-residency-with-apigee-hybrid.html)
- [v1.10](https://docs.cloud.google.com/apigee/docs/hybrid/v1.10/using-data-residency-with-apigee-hybrid.html)
- [v1.9](https://docs.cloud.google.com/apigee/docs/hybrid/v1.9/using-data-residency-with-apigee-hybrid.html)
- [v1.8](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/using-data-residency-with-apigee-hybrid.html)
- [v1.7](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/using-data-residency-with-apigee-hybrid.html)
- [v1.6](https://docs.cloud.google.com/apigee/docs/hybrid/v1.6/using-data-residency-with-apigee-hybrid.html)
- [v1.5](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/using-data-residency-with-apigee-hybrid.html)
- [v1.4](https://docs.cloud.google.com/apigee/docs/hybrid/v1.4/using-data-residency-with-apigee-hybrid.html)
- [v1.3](https://docs.cloud.google.com/apigee/docs/hybrid/v1.3/using-data-residency-with-apigee-hybrid.html)
- [v1.2](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/using-data-residency-with-apigee-hybrid.html)
- [v1.1](https://docs.cloud.google.com/apigee/docs/hybrid/v1.1/using-data-residency-with-apigee-hybrid.html)

This topic explains how to configure a new Apigee hybrid installation for data residency
compliance.

## About data residency

Starting with hybrid version 1.12, 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, see [Introduction to data residency](https://docs.cloud.google.com/apigee/docs/api-platform/get-started/drz-concepts.md.txt).

## 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](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/using-data-residency-with-apigee-hybrid.md.txt#creatinganorg)
- [Creating an environment using the Apigee API](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/using-data-residency-with-apigee-hybrid.md.txt#createinganenv)
- [Enabling the new data pipeline](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/using-data-residency-with-apigee-hybrid.md.txt#newpipeline)
- [Configuring the overrides file(s)](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/using-data-residency-with-apigee-hybrid.md.txt#configureoverrides)

### Creating an Apigee organization with data residency

When you create an Apigee organization, you have the option of enabling the org with
data residency. Creating an org with data residency requires you to specify two
key location attributes: the **control plane location** and the **consumer data region** .
You will also need to specify the **billing type** . For details, see
[Step 2: Create an organization](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/precog-provision.md.txt).

- **Control plane location** : You need to specify the location where customer core content like proxy bundles are stored. For a list see [Available Apigee API control plane regions](https://docs.cloud.google.com/apigee/docs/locations.md.txt#available-apigee-api-control-plane-regions).


  The control plane location is the location of the service endpoint location, for example `us` for 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: `apigee.us.rep.googleapis.com` **Note:** See also [Use VPC Service Controls with data residency](https://docs.cloud.google.com/apigee/docs/api-platform/get-started/drz-concepts.md.txt#drz-vpc-sc). |
  | Canada | `ca (multiple regions in Canada)` | Service endpoint: `ca-apigee.googleapis.com` |

  | Consumer data region description | Consumer data region name | Details |
  |---|---|---|
  | Iowa | `us-central1` | ![leaf icon](https://cloud.google.com/sustainability/region-carbon/gleaf.svg) [Low CO~2~](https://cloud.google.com/sustainability/region-carbon#region-picker) |
  | Oregon | `us-west1` | ![leaf icon](https://cloud.google.com/sustainability/region-carbon/gleaf.svg) [Low CO~2~](https://cloud.google.com/sustainability/region-carbon#region-picker) |
  | Los Angeles | `us-west2` |   |
  | Salt Lake City | `us-west3` |   |
  | Las Vegas | `us-west4` |   |
  | South Carolina | `us-east1` |   |
  | Northern Virginia | `us-east4` |   |
  | Columbus | `us-east5` |   |
  | Dallas | `us-south1` |   |
  | Montréal | `northamerica-northeast1` | ![leaf icon](https://cloud.google.com/sustainability/region-carbon/gleaf.svg) [Low CO~2~](https://cloud.google.com/sustainability/region-carbon#region-picker) |
  | Toronto | `northamerica-northeast2` | ![leaf icon](https://cloud.google.com/sustainability/region-carbon/gleaf.svg) [Low CO~2~](https://cloud.google.com/sustainability/region-carbon#region-picker) |

  ### Europe

  | Control plane hosting jurisdiction description | Control plane hosting jurisdiction name | Details |
  |---|---|---|
  | European Union | `eu (multiple regions in the European Union)` | Service endpoint: `apigee.eu.rep.googleapis.com` **Note:** See also [Use VPC Service Controls with data residency](https://docs.cloud.google.com/apigee/docs/api-platform/get-started/drz-concepts.md.txt#drz-vpc-sc). |
  | Germany | `de (multiple regions in Germany)` | Service endpoint: `de-apigee.googleapis.com` |
  | France | `fr (single region europe-west9)` | Service endpoint: `fr-apigee.googleapis.com` |
  | Switzerland | `ch (single region europe-west6)` | Service endpoint: `ch-apigee.googleapis.com` |

  | Consumer data region description | Consumer data region name | Details |
  |---|---|---|
  | Belgium | `europe-west1` | ![leaf icon](https://cloud.google.com/sustainability/region-carbon/gleaf.svg) [Low CO~2~](https://cloud.google.com/sustainability/region-carbon#region-picker) |
  | Frankfurt | `europe-west3` |   |
  | Netherlands | `europe-west4` |   |
  | Zurich | `europe-west6` | ![leaf icon](https://cloud.google.com/sustainability/region-carbon/gleaf.svg) [Low CO~2~](https://cloud.google.com/sustainability/region-carbon#region-picker) |
  | Milan | `europe-west8` |   |
  | Paris | `europe-west9` | ![leaf icon](https://cloud.google.com/sustainability/region-carbon/gleaf.svg) [Low CO~2~](https://cloud.google.com/sustainability/region-carbon#region-picker) |
  | Turin | `europe-west12` |   |
  | Warsaw | `europe-central2` |   |
  | Madrid | `europe-southwest1` | ![leaf icon](https://cloud.google.com/sustainability/region-carbon/gleaf.svg) [Low CO~2~](https://cloud.google.com/sustainability/region-carbon#region-picker) |
  | Finland | `europe-north1` | ![leaf icon](https://cloud.google.com/sustainability/region-carbon/gleaf.svg) [Low CO~2~](https://cloud.google.com/sustainability/region-carbon#region-picker) |

  ### Asia-Pacific

  | Control plane hosting jurisdiction description | Control plane hosting jurisdiction name | Details |
  |---|---|---|
  | Australia | `au (multiple regions in Australia)` | Service endpoint: `au-apigee.googleapis.com` |
  | India | `in (multiple regions in India)` | Service endpoint: `apigee.in.rep.googleapis.com` **Note:** See also [Use VPC Service Controls with data residency](https://docs.cloud.google.com/apigee/docs/api-platform/get-started/drz-concepts.md.txt#drz-vpc-sc). |
  | Japan | `jp (multiple regions in Japan)` | Service endpoint: `jp-apigee.googleapis.com` |

  | Consumer data region description | Consumer data region name | Details |
  |---|---|---|
  | Sydney | `australia-southeast1` |   |
  | Melbourne | `australia-southeast2` |   |
  | Mumbai | `asia-south1` |   |
  | Delhi | `asia-south2` |   |
  | Tokyo | `asia-northeast1` |   |
  | Osaka | `asia-northeast2` |   |

  ### Middle East

  | Control plane hosting juridiction description | Control plane hosting jurisdiction name | Details |
  |---|---|---|
  | Qatar | `qa (single region me-central1)` | Service endpoint: `qa-apigee.googleapis.com` |
  | Saudi Arabia | `sa (single region me-central2)` | Service endpoint: `sa-apigee.googleapis.com` |
  | Israel | `il (single region me-west1)` | Service endpoint: `il-apigee.googleapis.com` |

  | Consumer data region description | Consumer data region name | Details |
  |---|---|---|
  | Doha | `me-central1` |   |
  | Dammam | `me-central2` |   |
  | Tel 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](https://docs.cloud.google.com/apigee/docs/locations.md.txt#consumer-data-region).
- **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 the
control plane location. See [Create an environment](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/precog-add-environment.md.txt#apigee-apit).
If you use the UI to create an environment, no special steps are needed.

### Enabling the new data pipeline

When data residency is enabled for a new hybrid v1.13 organization, you must enable the new data pipeline
feature. This feature enables analytics and debug data to be sent to the Apigee control plane. To
enable the data pipeline, follow the instructions in
[Configure hybrid to use the new data pipeline](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/data-collection-with-data-residency.md.txt).

`newDataPipeline.debugSession` and `newDataPipeline.analytics` are set to `true` by default in hybrid v1.14.0 and later. You will not need to explicitly set these values unless you have previously set them to `false`.

#### Overrides changes to enable the new data pipeline


Add the following configuration properties to each overrides file and apply them:

- `contractProvider`: The service endpoint for Apigee management APIs. For example: `https://us-apigee.googleapis.com`.
- `newDataPipeline.debugSession`: Set this to `true` to use the new data pipeline.
- `newDataPipeline.analytics`: Set this to `true` to enable analytics to use the new data pipeline.

For example:

```
instanceID: "my_hybrid_example"
namespace: apigee

gcp:
  projectID: hybrid-example
  region: us-central1

k8sCluster:
  name: apigee-hybrid
  region: us-central1

org: hybrid-example

contractProvider: https://us-apigee.googleapis.com
newDataPipeline:
  debugSession: true
  analytics: true
```

See [Step 6: Create the overrides](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/install-create-overrides.md.txt)

### When calling the Apigee APIs

When you make `curl` 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.com`
- `ANALYTICS_REGION-pubsub.googleapis.com`
- URLs required by Apigee hybrid, see [Google Cloud URLs to allow for Hybrid](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/allow-gcp-urls.md.txt).

### Enable analytics and debug data collection with data residency

To enable analytics and debug data collection, follow the instructions
in [Configure hybrid to use the new data pipeline](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/data-collection-with-data-residency.md.txt).