---
title: Origin Cloud Regions
---

[Skip to content](#_top)

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

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

Copy Markdown

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

---

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

# Origin Cloud Regions

##### [List origin cloud region mappings](https://developers.cloudflare.com/api/python/resources/cache/subresources/origin_cloud_regions/methods/list)

cache.origin\_cloud\_regions.list(OriginCloudRegionListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[OriginCloudRegionListResponse](<https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_list_response%20%3E%20(schema)>)]

GET/zones/{zone\_id}/origin/cloud\_regions

##### [Get an origin cloud region mapping](https://developers.cloudflare.com/api/python/resources/cache/subresources/origin_cloud_regions/methods/get)

cache.origin\_cloud\_regions.get(strorigin\_ip, OriginCloudRegionGetParams\*\*kwargs) -> [OriginCloudRegionGetResponse](<https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_get_response%20%3E%20(schema)>)

GET/zones/{zone\_id}/origin/cloud\_regions/{origin\_ip}

##### [Create or replace an origin cloud region mapping](https://developers.cloudflare.com/api/python/resources/cache/subresources/origin_cloud_regions/methods/update)

cache.origin\_cloud\_regions.update(strpath\_origin\_ip, OriginCloudRegionUpdateParams\*\*kwargs) -> [OriginCloudRegionUpdateResponse](<https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_update_response%20%3E%20(schema)>)

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

##### [Delete an origin cloud region mapping](https://developers.cloudflare.com/api/python/resources/cache/subresources/origin_cloud_regions/methods/delete)

cache.origin\_cloud\_regions.delete(strorigin\_ip, OriginCloudRegionDeleteParams\*\*kwargs) -> [OriginCloudRegionDeleteResponse](<https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_delete_response%20%3E%20(schema)>)

DELETE/zones/{zone\_id}/origin/cloud\_regions/{origin\_ip}

##### [Batch create or replace origin cloud region mappings](https://developers.cloudflare.com/api/python/resources/cache/subresources/origin_cloud_regions/methods/bulk_update)

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

##### [Batch delete origin cloud region mappings](https://developers.cloudflare.com/api/python/resources/cache/subresources/origin_cloud_regions/methods/bulk_delete)

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

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

##### [List supported cloud vendors and regions](https://developers.cloudflare.com/api/python/resources/cache/subresources/origin_cloud_regions/methods/supported_regions)

cache.origin\_cloud\_regions.supported\_regions(OriginCloudRegionSupportedRegionsParams\*\*kwargs) -> [OriginCloudRegionSupportedRegionsResponse](<https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_supported_regions_response%20%3E%20(schema)>)

GET/zones/{zone\_id}/origin/cloud\_regions/supported\_regions

##### ModelsExpand Collapse

<details>

<summary>

class OriginCloudRegionListResponse: …

A single origin IP-to-cloud-region mapping.

</summary>

origin\_ip: str

The origin IP address (IPv4 or IPv6). Normalized to canonical form (RFC 5952 for IPv6).

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

region: str

Cloud vendor region identifier.

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

<details>

<summary>

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

Cloud vendor hosting the origin.

</summary>

One of the following:

"aws"

<a href="#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_list_response%20%3E%20(schema)%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(model)%20origin_cloud_region_list_response%20%3E%20(schema)%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(model)%20origin_cloud_region_list_response%20%3E%20(schema)%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(model)%20origin_cloud_region_list_response%20%3E%20(schema)%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(model)%20origin_cloud_region_list_response%20%3E%20(schema)%20%3E%20(property)%20vendor">Link to this property</a>

modified\_on: Optional\[datetime]

Time this mapping was last modified.

formatdate-time

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

</details>

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

<details>

<summary>

class OriginCloudRegionGetResponse: …

A single origin IP-to-cloud-region mapping.

</summary>

origin\_ip: str

The origin IP address (IPv4 or IPv6). Normalized to canonical form (RFC 5952 for IPv6).

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

region: str

Cloud vendor region identifier.

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

<details>

<summary>

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

Cloud vendor hosting the origin.

</summary>

One of the following:

"aws"

<a href="#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_get_response%20%3E%20(schema)%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(model)%20origin_cloud_region_get_response%20%3E%20(schema)%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(model)%20origin_cloud_region_get_response%20%3E%20(schema)%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(model)%20origin_cloud_region_get_response%20%3E%20(schema)%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(model)%20origin_cloud_region_get_response%20%3E%20(schema)%20%3E%20(property)%20vendor">Link to this property</a>

modified\_on: Optional\[datetime]

Time this mapping was last modified.

formatdate-time

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

</details>

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

<details>

<summary>

class OriginCloudRegionUpdateResponse: …

A single origin IP-to-cloud-region mapping.

</summary>

origin\_ip: str

The origin IP address (IPv4 or IPv6). Normalized to canonical form (RFC 5952 for IPv6).

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

region: str

Cloud vendor region identifier.

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

<details>

<summary>

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

Cloud vendor hosting the origin.

</summary>

One of the following:

"aws"

<a href="#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_update_response%20%3E%20(schema)%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(model)%20origin_cloud_region_update_response%20%3E%20(schema)%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(model)%20origin_cloud_region_update_response%20%3E%20(schema)%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(model)%20origin_cloud_region_update_response%20%3E%20(schema)%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(model)%20origin_cloud_region_update_response%20%3E%20(schema)%20%3E%20(property)%20vendor">Link to this property</a>

modified\_on: Optional\[datetime]

Time this mapping was last modified.

formatdate-time

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

</details>

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

<details>

<summary>

class OriginCloudRegionDeleteResponse: …

Response result for a delete operation. Identifies the deleted mapping.

</summary>

origin\_ip: str

The origin IP address whose mapping was deleted.

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

</details>

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

<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)>)

<details>

<summary>

class OriginCloudRegionBulkDeleteResponse: …

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_delete_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_delete_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_delete_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_delete_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_delete_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_delete_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_delete_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_delete_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_delete_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_delete_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_delete_response%20%3E%20(schema)>)

<details>

<summary>

class OriginCloudRegionSupportedRegionsResponse: …

Cloud vendors and their supported regions for origin cloud region mappings.

</summary>

obtained\_codes: bool

Whether Cloudflare airport codes (IATA colo identifiers) were successfully resolved for the <code>upper_tier_colos</code> field on each region. When <code>false</code>, the <code>upper_tier_colos</code> arrays may be empty or incomplete.

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

<details>

<summary>

vendors: Dict\[str, List\[Vendor]]

Map of vendor name to list of supported regions.

</summary>

name: str

Cloud vendor region identifier.

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

upper\_tier\_colos: List\[str]

Cloudflare Tiered Cache upper-tier colocation codes co-located with this cloud region. Requests from zones with a matching origin mapping will be routed through these colos.

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

</details>

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

</details>

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