---
title: Batch create or replace origin cloud region mappings
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/python)

[Cache](https://developers.cloudflare.com/api/python/resources/cache)

[Origin Cloud Regions](https://developers.cloudflare.com/api/python/resources/cache/subresources/origin_cloud_regions)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Batch create or replace origin cloud region mappings

cache.origin\_cloud\_regions.bulk\_update(OriginCloudRegionBulkUpdateParams\*\*kwargs) -> [OriginCloudRegionBulkUpdateResponse](<https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_bulk_update_response%20%3E%20(schema)>)

PUT/zones/{zone\_id}/origin/cloud\_regions/batch

Upserts up to 100 IP-to-cloud-region mappings in a single request. Items in the request body are created or replaced; mappings not included in the request body are preserved unchanged (this is a merge operation, not a full collection replacement). Each item is validated independently — valid items are applied and invalid items are returned in the `failed` array. The vendor and region for every item are validated against the list from `GET /zones/{zone_id}/origin/cloud_regions/supported_regions`.

##### Security

<details>

<summary>API Token</summary>



The preferred authorization scheme for interacting with the Cloudflare API. <a href="https://developers.cloudflare.com/fundamentals/api/get-started/create-token/">Create a token</a>.

**Example:**<code>Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY</code>

</details>

<details>

<summary>API Email + API Key</summary>



The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

**Example:**<code>X-Auth-Email: user@example.com</code>

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

**Example:**<code>X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194</code>

</details>

##### ParametersExpand Collapse

zone\_id: str

Identifier.

maxLength32

[Link to this property](<#(resource)%20cache.origin_cloud_regions%20%3E%20(method)%20bulk_update%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>)

<details>

<summary>

body: Iterable\[Body]

</summary>

origin\_ip: str

Origin IP address (IPv4 or IPv6). For the single PUT endpoint (<code>PUT /origin/cloud_regions/{origin_ip}</code>), this field must match the path parameter or the request will be rejected with a 400 error. For the batch PUT endpoint, this field identifies which mapping to upsert.

<a href="#(resource)%20cache.origin_cloud_regions%20%3E%20(method)%20bulk_update%20%3E%20(params)%20default%20%3E%20(param)%20body%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20origin_ip">Link to this property</a>

region: str

Cloud vendor region identifier. Must be a valid region for the specified vendor as returned by the supported\_regions endpoint.

<a href="#(resource)%20cache.origin_cloud_regions%20%3E%20(method)%20bulk_update%20%3E%20(params)%20default%20%3E%20(param)%20body%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20region">Link to this property</a>

<details>

<summary>

vendor: Literal\["aws", "azure", "gcp", "oci"]

Cloud vendor hosting the origin. Must be one of the supported vendors.

</summary>

One of the following:

"aws"

<a href="#(resource)%20cache.origin_cloud_regions%20%3E%20(method)%20bulk_update%20%3E%20(params)%20default%20%3E%20(param)%20body%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20vendor%20%3E%20(member)%200">Link to this property</a>

"azure"

<a href="#(resource)%20cache.origin_cloud_regions%20%3E%20(method)%20bulk_update%20%3E%20(params)%20default%20%3E%20(param)%20body%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20vendor%20%3E%20(member)%201">Link to this property</a>

"gcp"

<a href="#(resource)%20cache.origin_cloud_regions%20%3E%20(method)%20bulk_update%20%3E%20(params)%20default%20%3E%20(param)%20body%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20vendor%20%3E%20(member)%202">Link to this property</a>

"oci"

<a href="#(resource)%20cache.origin_cloud_regions%20%3E%20(method)%20bulk_update%20%3E%20(params)%20default%20%3E%20(param)%20body%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20vendor%20%3E%20(member)%203">Link to this property</a>

</details>

<a href="#(resource)%20cache.origin_cloud_regions%20%3E%20(method)%20bulk_update%20%3E%20(params)%20default%20%3E%20(param)%20body%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20vendor">Link to this property</a>

</details>

[Link to this property](<#(resource)%20cache.origin_cloud_regions%20%3E%20(method)%20bulk_update%20%3E%20(params)%20default%20%3E%20(param)%20body%20%3E%20(schema)>)

##### ReturnsExpand Collapse

<details>

<summary>

class OriginCloudRegionBulkUpdateResponse: …

Response result for a batch origin cloud region operation.

</summary>

<details>

<summary>

failed: List\[Failed]

Items that could not be applied, with error details.

</summary>

origin\_ip: str

The origin IP address for this item.

<a href="#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_bulk_update_response%20%3E%20(schema)%20%3E%20(property)%20failed%20%3E%20(items)%20%3E%20(property)%20origin_ip">Link to this property</a>

error: Optional\[str]

Error message explaining why the item failed. Present only on failed items.

<a href="#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_bulk_update_response%20%3E%20(schema)%20%3E%20(property)%20failed%20%3E%20(items)%20%3E%20(property)%20error">Link to this property</a>

region: Optional\[str]

Cloud vendor region identifier. Present on succeeded items (the new value for upsert, the deleted value for delete).

<a href="#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_bulk_update_response%20%3E%20(schema)%20%3E%20(property)%20failed%20%3E%20(items)%20%3E%20(property)%20region">Link to this property</a>

vendor: Optional\[str]

Cloud vendor identifier. Present on succeeded items (the new value for upsert, the deleted value for delete).

<a href="#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_bulk_update_response%20%3E%20(schema)%20%3E%20(property)%20failed%20%3E%20(items)%20%3E%20(property)%20vendor">Link to this property</a>

</details>

<a href="#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_bulk_update_response%20%3E%20(schema)%20%3E%20(property)%20failed">Link to this property</a>

<details>

<summary>

succeeded: List\[Succeeded]

Items that were successfully applied.

</summary>

origin\_ip: str

The origin IP address for this item.

<a href="#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_bulk_update_response%20%3E%20(schema)%20%3E%20(property)%20succeeded%20%3E%20(items)%20%3E%20(property)%20origin_ip">Link to this property</a>

error: Optional\[str]

Error message explaining why the item failed. Present only on failed items.

<a href="#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_bulk_update_response%20%3E%20(schema)%20%3E%20(property)%20succeeded%20%3E%20(items)%20%3E%20(property)%20error">Link to this property</a>

region: Optional\[str]

Cloud vendor region identifier. Present on succeeded items (the new value for upsert, the deleted value for delete).

<a href="#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_bulk_update_response%20%3E%20(schema)%20%3E%20(property)%20succeeded%20%3E%20(items)%20%3E%20(property)%20region">Link to this property</a>

vendor: Optional\[str]

Cloud vendor identifier. Present on succeeded items (the new value for upsert, the deleted value for delete).

<a href="#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_bulk_update_response%20%3E%20(schema)%20%3E%20(property)%20succeeded%20%3E%20(items)%20%3E%20(property)%20vendor">Link to this property</a>

</details>

<a href="#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_bulk_update_response%20%3E%20(schema)%20%3E%20(property)%20succeeded">Link to this property</a>

</details>

[Link to this property](<#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_bulk_update_response%20%3E%20(schema)>)

### Batch create or replace origin cloud region mappings

Python

HTTPTypeScriptPythonGoTerraform

```
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
response = client.cache.origin_cloud_regions.bulk_update(
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    body=[{
        "origin_ip": "192.0.2.1",
        "region": "us-east-1",
        "vendor": "aws",
    }, {
        "origin_ip": "2001:db8::1",
        "region": "us-central1",
        "vendor": "gcp",
    }],
)
print(response.failed)
```

200 example

4XX example

```
{
  "errors": [],
  "messages": [],
  "result": {
    "failed": [],
    "succeeded": [
      {
        "origin_ip": "192.0.2.1",
        "region": "us-east-1",
        "vendor": "aws"
      },
      {
        "origin_ip": "2001:db8::1",
        "region": "us-central1",
        "vendor": "gcp"
      }
    ]
  },
  "success": true
}
```

```
{
  "errors": [
    {
      "code": 1164,
      "message": "Maximum number of IP mappings configured for zone."
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}
```

##### Returns Examples

200 example

4XX example

```
{
  "errors": [],
  "messages": [],
  "result": {
    "failed": [],
    "succeeded": [
      {
        "origin_ip": "192.0.2.1",
        "region": "us-east-1",
        "vendor": "aws"
      },
      {
        "origin_ip": "2001:db8::1",
        "region": "us-central1",
        "vendor": "gcp"
      }
    ]
  },
  "success": true
}
```

```
{
  "errors": [
    {
      "code": 1164,
      "message": "Maximum number of IP mappings configured for zone."
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}
```