Batch create or update origin cloud region mappings

cache.origin_cloud_regions.bulk_edit() -> OriginCloudRegionBulkEditResponse

PATCH/zones/{zone_id}/cache/origin_cloud_regions/batch

Adds or updates up to 100 IP-to-cloud-region mappings in a single request. 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}/cache/origin_cloud_regions/supported_regions.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

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

Example:X-Auth-Email: user@example.com

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

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

ParametersExpand Collapse

zone_id: str

Identifier.

maxLength32

body: Iterable[Body]

ip: str

Origin IP address (IPv4 or IPv6). Normalized to canonical form before storage (RFC 5952 for IPv6).

region: str

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

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

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

One of the following:

"aws"

"azure"

"gcp"

"oci"

ReturnsExpand Collapse

class OriginCloudRegionBulkEditResponse: …

Response result for a batch origin cloud region operation.

id: Literal["origin_public_cloud_region"]

editable: bool

Whether the setting can be modified by the current user.

value: Value

failed: List[ValueFailed]

Items that could not be applied, with error details.

origin_ip: str

The origin IP address for this item.

error: Optional[str]

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

region: Optional[str]

Cloud vendor region identifier. Present on succeeded items for patch operations.

vendor: Optional[str]

Cloud vendor identifier. Present on succeeded items for patch operations.

succeeded: List[ValueSucceeded]

Items that were successfully applied.

origin_ip: str

The origin IP address for this item.

error: Optional[str]

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

region: Optional[str]

Cloud vendor region identifier. Present on succeeded items for patch operations.

vendor: Optional[str]

Cloud vendor identifier. Present on succeeded items for patch operations.

modified_on: Optional[datetime]

Time the mapping set was last modified. Null when no items were successfully applied.

formatdate-time

Batch create or update origin cloud region mappings

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_edit(
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    body=[{
        "ip": "192.0.2.1",
        "region": "us-east-1",
        "vendor": "aws",
    }, {
        "ip": "2001:db8::1",
        "region": "us-central1",
        "vendor": "gcp",
    }],
)
print(response.id)

{
  "errors": [],
  "messages": [],
  "result": {
    "editable": true,
    "id": "origin_public_cloud_region",
    "modified_on": "2026-03-01T12:00:00Z",
    "value": {
      "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
}

{
  "errors": [
    {
      "code": 1140,
      "message": "Unable to update origin_public_cloud_region setting value. Internal error."
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}

{
  "errors": [
    {
      "code": 1156,
      "message": "Failed to validate region against cloud vendor"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}

Returns Examples

{
  "errors": [],
  "messages": [],
  "result": {
    "editable": true,
    "id": "origin_public_cloud_region",
    "modified_on": "2026-03-01T12:00:00Z",
    "value": {
      "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
}

{
  "errors": [
    {
      "code": 1140,
      "message": "Unable to update origin_public_cloud_region setting value. Internal error."
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}

{
  "errors": [
    {
      "code": 1156,
      "message": "Failed to validate region against cloud vendor"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}