---
title: Cache
---

[Skip to content](#_top)

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

Copy Markdown

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

---

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

# Cache

##### [Purge Cached Content](https://developers.cloudflare.com/api/python/resources/cache/methods/purge)

cache.purge(CachePurgeParams\*\*kwargs) -> [CachePurgeResponse](<https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache%20%3E%20(model)%20cache_purge_response%20%3E%20(schema)>)

POST/zones/{zone\_id}/purge\_cache

##### [Purge Cached Content by Environment](https://developers.cloudflare.com/api/python/resources/cache/methods/purge_environment)

cache.purge\_environment(strenvironment\_id, CachePurgeEnvironmentParams\*\*kwargs) -> [CachePurgeEnvironmentResponse](<https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache%20%3E%20(model)%20cache_purge_environment_response%20%3E%20(schema)>)

POST/zones/{zone\_id}/environments/{environment\_id}/purge\_cache

##### [Invalidate Cached Content](https://developers.cloudflare.com/api/python/resources/cache/methods/invalidate)

cache.invalidate(CacheInvalidateParams\*\*kwargs) -> [CacheInvalidateResponse](<https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache%20%3E%20(model)%20cache_invalidate_response%20%3E%20(schema)>)

POST/zones/{zone\_id}/invalidate\_cache

##### [Invalidate Cached Content by Environment](https://developers.cloudflare.com/api/python/resources/cache/methods/invalidate_environment)

cache.invalidate\_environment(strenvironment\_id, CacheInvalidateEnvironmentParams\*\*kwargs) -> [CacheInvalidateEnvironmentResponse](<https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache%20%3E%20(model)%20cache_invalidate_environment_response%20%3E%20(schema)>)

POST/zones/{zone\_id}/environments/{environment\_id}/invalidate\_cache

##### ModelsExpand Collapse

<details>

<summary>

class CachePurgeResponse: …

</summary>

id: str

maxLength32

<a href="#(resource)%20cache%20%3E%20(model)%20cache_purge_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

</details>

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

<details>

<summary>

class CachePurgeEnvironmentResponse: …

</summary>

id: str

maxLength32

<a href="#(resource)%20cache%20%3E%20(model)%20cache_purge_environment_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

</details>

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

<details>

<summary>

class CacheInvalidateResponse: …

</summary>

id: str

maxLength32

<a href="#(resource)%20cache%20%3E%20(model)%20cache_invalidate_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

</details>

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

<details>

<summary>

class CacheInvalidateEnvironmentResponse: …

</summary>

id: str

maxLength32

<a href="#(resource)%20cache%20%3E%20(model)%20cache_invalidate_environment_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

</details>

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

#### CacheCache Reserve

##### [Get Cache Reserve setting](https://developers.cloudflare.com/api/python/resources/cache/subresources/cache_reserve/methods/get)

cache.cache\_reserve.get(CacheReserveGetParams\*\*kwargs) -> [CacheReserveGetResponse](<https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_get_response%20%3E%20(schema)>)

GET/zones/{zone\_id}/cache/cache\_reserve

##### [Change Cache Reserve setting](https://developers.cloudflare.com/api/python/resources/cache/subresources/cache_reserve/methods/edit)

cache.cache\_reserve.edit(CacheReserveEditParams\*\*kwargs) -> [CacheReserveEditResponse](<https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_edit_response%20%3E%20(schema)>)

PATCH/zones/{zone\_id}/cache/cache\_reserve

##### [Get Cache Reserve Clear](https://developers.cloudflare.com/api/python/resources/cache/subresources/cache_reserve/methods/status)

cache.cache\_reserve.status(CacheReserveStatusParams\*\*kwargs) -> [CacheReserveStatusResponse](<https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_status_response%20%3E%20(schema)>)

GET/zones/{zone\_id}/cache/cache\_reserve\_clear

##### [Start Cache Reserve Clear](https://developers.cloudflare.com/api/python/resources/cache/subresources/cache_reserve/methods/clear)

cache.cache\_reserve.clear(CacheReserveClearParams\*\*kwargs) -> [CacheReserveClearResponse](<https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_clear_response%20%3E%20(schema)>)

POST/zones/{zone\_id}/cache/cache\_reserve\_clear

##### ModelsExpand Collapse

Literal\["cache\_reserve"]

The identifier of the caching setting.

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

Literal\["cache\_reserve\_clear"]

ID of the zone setting.

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

<details>

<summary>

class CacheReserveGetResponse: …

</summary>

id: <a href="https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve%20%3E%20(schema)">CacheReserve</a>

The identifier of the caching setting.

<a href="#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_get_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

editable: bool

Whether the setting is editable.

<a href="#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_get_response%20%3E%20(schema)%20%3E%20(property)%20editable">Link to this property</a>

<details>

<summary>

value: Literal\["on", "off"]

Value of the Cache Reserve zone setting.

</summary>

One of the following:

"on"

<a href="#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_get_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(member)%200">Link to this property</a>

"off"

<a href="#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_get_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_get_response%20%3E%20(schema)%20%3E%20(property)%20value">Link to this property</a>

modified\_on: Optional\[datetime]

Last time this setting was modified.

formatdate-time

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

</details>

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

<details>

<summary>

class CacheReserveEditResponse: …

</summary>

id: <a href="https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve%20%3E%20(schema)">CacheReserve</a>

The identifier of the caching setting.

<a href="#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_edit_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

editable: bool

Whether the setting is editable.

<a href="#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_edit_response%20%3E%20(schema)%20%3E%20(property)%20editable">Link to this property</a>

<details>

<summary>

value: Literal\["on", "off"]

Value of the Cache Reserve zone setting.

</summary>

One of the following:

"on"

<a href="#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_edit_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(member)%200">Link to this property</a>

"off"

<a href="#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_edit_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_edit_response%20%3E%20(schema)%20%3E%20(property)%20value">Link to this property</a>

modified\_on: Optional\[datetime]

Last time this setting was modified.

formatdate-time

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

</details>

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

<details>

<summary>

class CacheReserveStatusResponse: …

You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation.

</summary>

id: <a href="https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_clear%20%3E%20(schema)">CacheReserveClear</a>

ID of the zone setting.

<a href="#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_status_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

start\_ts: datetime

The time that the latest Cache Reserve Clear operation started.

formatdate-time

<a href="#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_status_response%20%3E%20(schema)%20%3E%20(property)%20start_ts">Link to this property</a>

<details>

<summary>

state: Literal\["In-progress", "Completed"]

The current state of the Cache Reserve Clear operation.

</summary>

One of the following:

"In-progress"

<a href="#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_status_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%200">Link to this property</a>

"Completed"

<a href="#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_status_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_status_response%20%3E%20(schema)%20%3E%20(property)%20state">Link to this property</a>

end\_ts: Optional\[datetime]

The time that the latest Cache Reserve Clear operation completed.

formatdate-time

<a href="#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_status_response%20%3E%20(schema)%20%3E%20(property)%20end_ts">Link to this property</a>

modified\_on: Optional\[datetime]

Last time this setting was modified.

formatdate-time

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

</details>

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

<details>

<summary>

class CacheReserveClearResponse: …

You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation.

</summary>

id: <a href="https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_clear%20%3E%20(schema)">CacheReserveClear</a>

ID of the zone setting.

<a href="#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_clear_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

start\_ts: datetime

The time that the latest Cache Reserve Clear operation started.

formatdate-time

<a href="#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_clear_response%20%3E%20(schema)%20%3E%20(property)%20start_ts">Link to this property</a>

<details>

<summary>

state: Literal\["In-progress", "Completed"]

The current state of the Cache Reserve Clear operation.

</summary>

One of the following:

"In-progress"

<a href="#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_clear_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%200">Link to this property</a>

"Completed"

<a href="#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_clear_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_clear_response%20%3E%20(schema)%20%3E%20(property)%20state">Link to this property</a>

end\_ts: Optional\[datetime]

The time that the latest Cache Reserve Clear operation completed.

formatdate-time

<a href="#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_clear_response%20%3E%20(schema)%20%3E%20(property)%20end_ts">Link to this property</a>

modified\_on: Optional\[datetime]

Last time this setting was modified.

formatdate-time

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

</details>

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

#### CacheSmart Tiered Cache

##### [Get Smart Tiered Cache setting](https://developers.cloudflare.com/api/python/resources/cache/subresources/smart_tiered_cache/methods/get)

cache.smart\_tiered\_cache.get(SmartTieredCacheGetParams\*\*kwargs) -> [SmartTieredCacheGetResponse](<https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.smart_tiered_cache%20%3E%20(model)%20smart_tiered_cache_get_response%20%3E%20(schema)>)

GET/zones/{zone\_id}/cache/tiered\_cache\_smart\_topology\_enable

##### [Create Smart Tiered Cache setting](https://developers.cloudflare.com/api/python/resources/cache/subresources/smart_tiered_cache/methods/create)

cache.smart\_tiered\_cache.create(SmartTieredCacheCreateParams\*\*kwargs) -> [SmartTieredCacheCreateResponse](<https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.smart_tiered_cache%20%3E%20(model)%20smart_tiered_cache_create_response%20%3E%20(schema)>)

POST/zones/{zone\_id}/cache/tiered\_cache\_smart\_topology\_enable

##### [Patch Smart Tiered Cache setting](https://developers.cloudflare.com/api/python/resources/cache/subresources/smart_tiered_cache/methods/edit)

cache.smart\_tiered\_cache.edit(SmartTieredCacheEditParams\*\*kwargs) -> [SmartTieredCacheEditResponse](<https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.smart_tiered_cache%20%3E%20(model)%20smart_tiered_cache_edit_response%20%3E%20(schema)>)

PATCH/zones/{zone\_id}/cache/tiered\_cache\_smart\_topology\_enable

##### [Delete Smart Tiered Cache setting](https://developers.cloudflare.com/api/python/resources/cache/subresources/smart_tiered_cache/methods/delete)

cache.smart\_tiered\_cache.delete(SmartTieredCacheDeleteParams\*\*kwargs) -> [SmartTieredCacheDeleteResponse](<https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.smart_tiered_cache%20%3E%20(model)%20smart_tiered_cache_delete_response%20%3E%20(schema)>)

DELETE/zones/{zone\_id}/cache/tiered\_cache\_smart\_topology\_enable

##### ModelsExpand Collapse

<details>

<summary>

class SmartTieredCacheGetResponse: …

</summary>

id: Literal\["tiered\_cache\_smart\_topology\_enable"]

The identifier of the caching setting.

<a href="#(resource)%20cache.smart_tiered_cache%20%3E%20(model)%20smart_tiered_cache_get_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

editable: bool

Whether the setting is editable.

<a href="#(resource)%20cache.smart_tiered_cache%20%3E%20(model)%20smart_tiered_cache_get_response%20%3E%20(schema)%20%3E%20(property)%20editable">Link to this property</a>

<details>

<summary>

value: Literal\["on", "off"]

Value of the Smart Tiered Cache zone setting.

</summary>

One of the following:

"on"

<a href="#(resource)%20cache.smart_tiered_cache%20%3E%20(model)%20smart_tiered_cache_get_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(member)%200">Link to this property</a>

"off"

<a href="#(resource)%20cache.smart_tiered_cache%20%3E%20(model)%20smart_tiered_cache_get_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20cache.smart_tiered_cache%20%3E%20(model)%20smart_tiered_cache_get_response%20%3E%20(schema)%20%3E%20(property)%20value">Link to this property</a>

modified\_on: Optional\[datetime]

Last time this setting was modified.

formatdate-time

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

</details>

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

<details>

<summary>

class SmartTieredCacheCreateResponse: …

</summary>

id: Literal\["tiered\_cache\_smart\_topology\_enable"]

The identifier of the caching setting.

<a href="#(resource)%20cache.smart_tiered_cache%20%3E%20(model)%20smart_tiered_cache_create_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

editable: bool

Whether the setting is editable.

<a href="#(resource)%20cache.smart_tiered_cache%20%3E%20(model)%20smart_tiered_cache_create_response%20%3E%20(schema)%20%3E%20(property)%20editable">Link to this property</a>

<details>

<summary>

value: Literal\["on", "off"]

Value of the Smart Tiered Cache zone setting.

</summary>

One of the following:

"on"

<a href="#(resource)%20cache.smart_tiered_cache%20%3E%20(model)%20smart_tiered_cache_create_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(member)%200">Link to this property</a>

"off"

<a href="#(resource)%20cache.smart_tiered_cache%20%3E%20(model)%20smart_tiered_cache_create_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20cache.smart_tiered_cache%20%3E%20(model)%20smart_tiered_cache_create_response%20%3E%20(schema)%20%3E%20(property)%20value">Link to this property</a>

modified\_on: Optional\[datetime]

Last time this setting was modified.

formatdate-time

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

</details>

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

<details>

<summary>

class SmartTieredCacheEditResponse: …

</summary>

id: Literal\["tiered\_cache\_smart\_topology\_enable"]

The identifier of the caching setting.

<a href="#(resource)%20cache.smart_tiered_cache%20%3E%20(model)%20smart_tiered_cache_edit_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

editable: bool

Whether the setting is editable.

<a href="#(resource)%20cache.smart_tiered_cache%20%3E%20(model)%20smart_tiered_cache_edit_response%20%3E%20(schema)%20%3E%20(property)%20editable">Link to this property</a>

<details>

<summary>

value: Literal\["on", "off"]

Value of the Smart Tiered Cache zone setting.

</summary>

One of the following:

"on"

<a href="#(resource)%20cache.smart_tiered_cache%20%3E%20(model)%20smart_tiered_cache_edit_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(member)%200">Link to this property</a>

"off"

<a href="#(resource)%20cache.smart_tiered_cache%20%3E%20(model)%20smart_tiered_cache_edit_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20cache.smart_tiered_cache%20%3E%20(model)%20smart_tiered_cache_edit_response%20%3E%20(schema)%20%3E%20(property)%20value">Link to this property</a>

modified\_on: Optional\[datetime]

Last time this setting was modified.

formatdate-time

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

</details>

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

<details>

<summary>

class SmartTieredCacheDeleteResponse: …

</summary>

id: Literal\["tiered\_cache\_smart\_topology\_enable"]

The identifier of the caching setting.

<a href="#(resource)%20cache.smart_tiered_cache%20%3E%20(model)%20smart_tiered_cache_delete_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

editable: bool

Whether the setting is editable.

<a href="#(resource)%20cache.smart_tiered_cache%20%3E%20(model)%20smart_tiered_cache_delete_response%20%3E%20(schema)%20%3E%20(property)%20editable">Link to this property</a>

modified\_on: Optional\[datetime]

Last time this setting was modified.

formatdate-time

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

</details>

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

#### CacheVariants

##### [Get variants setting](https://developers.cloudflare.com/api/python/resources/cache/subresources/variants/methods/get)

cache.variants.get(VariantGetParams\*\*kwargs) -> [VariantGetResponse](<https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.variants%20%3E%20(model)%20variant_get_response%20%3E%20(schema)>)

GET/zones/{zone\_id}/cache/variants

##### [Change variants setting](https://developers.cloudflare.com/api/python/resources/cache/subresources/variants/methods/edit)

cache.variants.edit(VariantEditParams\*\*kwargs) -> [VariantEditResponse](<https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.variants%20%3E%20(model)%20variant_edit_response%20%3E%20(schema)>)

PATCH/zones/{zone\_id}/cache/variants

##### [Delete variants setting](https://developers.cloudflare.com/api/python/resources/cache/subresources/variants/methods/delete)

cache.variants.delete(VariantDeleteParams\*\*kwargs) -> [VariantDeleteResponse](<https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.variants%20%3E%20(model)%20variant_delete_response%20%3E%20(schema)>)

DELETE/zones/{zone\_id}/cache/variants

##### ModelsExpand Collapse

<details>

<summary>

class VariantGetResponse: …

</summary>

id: Literal\["variants"]

The identifier of the caching setting.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_get_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

editable: bool

Whether the setting is editable.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_get_response%20%3E%20(schema)%20%3E%20(property)%20editable">Link to this property</a>

<details>

<summary>

value: Value

Value of the zone setting.

</summary>

avif: Optional\[List\[str]]

List of strings with the MIME types of all the variants that should be served for avif.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_get_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20avif">Link to this property</a>

bmp: Optional\[List\[str]]

List of strings with the MIME types of all the variants that should be served for bmp.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_get_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20bmp">Link to this property</a>

gif: Optional\[List\[str]]

List of strings with the MIME types of all the variants that should be served for gif.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_get_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20gif">Link to this property</a>

jp2: Optional\[List\[str]]

List of strings with the MIME types of all the variants that should be served for jp2.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_get_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20jp2">Link to this property</a>

jpeg: Optional\[List\[str]]

List of strings with the MIME types of all the variants that should be served for jpeg.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_get_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20jpeg">Link to this property</a>

jpg: Optional\[List\[str]]

List of strings with the MIME types of all the variants that should be served for jpg.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_get_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20jpg">Link to this property</a>

jpg2: Optional\[List\[str]]

List of strings with the MIME types of all the variants that should be served for jpg2.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_get_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20jpg2">Link to this property</a>

png: Optional\[List\[str]]

List of strings with the MIME types of all the variants that should be served for png.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_get_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20png">Link to this property</a>

tif: Optional\[List\[str]]

List of strings with the MIME types of all the variants that should be served for tif.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_get_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20tif">Link to this property</a>

tiff: Optional\[List\[str]]

List of strings with the MIME types of all the variants that should be served for tiff.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_get_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20tiff">Link to this property</a>

webp: Optional\[List\[str]]

List of strings with the MIME types of all the variants that should be served for webp.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_get_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20webp">Link to this property</a>

</details>

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_get_response%20%3E%20(schema)%20%3E%20(property)%20value">Link to this property</a>

modified\_on: Optional\[datetime]

Last time this setting was modified.

formatdate-time

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

</details>

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

<details>

<summary>

class VariantEditResponse: …

</summary>

id: Literal\["variants"]

The identifier of the caching setting.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_edit_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

editable: bool

Whether the setting is editable.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_edit_response%20%3E%20(schema)%20%3E%20(property)%20editable">Link to this property</a>

<details>

<summary>

value: Value

Value of the zone setting.

</summary>

avif: Optional\[List\[str]]

List of strings with the MIME types of all the variants that should be served for avif.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_edit_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20avif">Link to this property</a>

bmp: Optional\[List\[str]]

List of strings with the MIME types of all the variants that should be served for bmp.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_edit_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20bmp">Link to this property</a>

gif: Optional\[List\[str]]

List of strings with the MIME types of all the variants that should be served for gif.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_edit_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20gif">Link to this property</a>

jp2: Optional\[List\[str]]

List of strings with the MIME types of all the variants that should be served for jp2.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_edit_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20jp2">Link to this property</a>

jpeg: Optional\[List\[str]]

List of strings with the MIME types of all the variants that should be served for jpeg.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_edit_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20jpeg">Link to this property</a>

jpg: Optional\[List\[str]]

List of strings with the MIME types of all the variants that should be served for jpg.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_edit_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20jpg">Link to this property</a>

jpg2: Optional\[List\[str]]

List of strings with the MIME types of all the variants that should be served for jpg2.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_edit_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20jpg2">Link to this property</a>

png: Optional\[List\[str]]

List of strings with the MIME types of all the variants that should be served for png.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_edit_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20png">Link to this property</a>

tif: Optional\[List\[str]]

List of strings with the MIME types of all the variants that should be served for tif.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_edit_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20tif">Link to this property</a>

tiff: Optional\[List\[str]]

List of strings with the MIME types of all the variants that should be served for tiff.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_edit_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20tiff">Link to this property</a>

webp: Optional\[List\[str]]

List of strings with the MIME types of all the variants that should be served for webp.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_edit_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20webp">Link to this property</a>

</details>

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_edit_response%20%3E%20(schema)%20%3E%20(property)%20value">Link to this property</a>

modified\_on: Optional\[datetime]

Last time this setting was modified.

formatdate-time

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

</details>

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

<details>

<summary>

class VariantDeleteResponse: …

</summary>

id: Literal\["variants"]

The identifier of the caching setting.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_delete_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

editable: bool

Whether the setting is editable.

<a href="#(resource)%20cache.variants%20%3E%20(model)%20variant_delete_response%20%3E%20(schema)%20%3E%20(property)%20editable">Link to this property</a>

modified\_on: Optional\[datetime]

Last time this setting was modified.

formatdate-time

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

</details>

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

#### CacheRegional Tiered Cache

##### [Get Regional Tiered Cache setting](https://developers.cloudflare.com/api/python/resources/cache/subresources/regional_tiered_cache/methods/get)

cache.regional\_tiered\_cache.get(RegionalTieredCacheGetParams\*\*kwargs) -> [RegionalTieredCacheGetResponse](<https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.regional_tiered_cache%20%3E%20(model)%20regional_tiered_cache_get_response%20%3E%20(schema)>)

GET/zones/{zone\_id}/cache/regional\_tiered\_cache

##### [Change Regional Tiered Cache setting](https://developers.cloudflare.com/api/python/resources/cache/subresources/regional_tiered_cache/methods/edit)

cache.regional\_tiered\_cache.edit(RegionalTieredCacheEditParams\*\*kwargs) -> [RegionalTieredCacheEditResponse](<https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.regional_tiered_cache%20%3E%20(model)%20regional_tiered_cache_edit_response%20%3E%20(schema)>)

PATCH/zones/{zone\_id}/cache/regional\_tiered\_cache

##### ModelsExpand Collapse

Literal\["tc\_regional"]

The identifier of the caching setting.

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

<details>

<summary>

class RegionalTieredCacheGetResponse: …

</summary>

id: <a href="https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.regional_tiered_cache%20%3E%20(model)%20regional_tiered_cache%20%3E%20(schema)">RegionalTieredCache</a>

The identifier of the caching setting.

<a href="#(resource)%20cache.regional_tiered_cache%20%3E%20(model)%20regional_tiered_cache_get_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

editable: bool

Whether the setting is editable.

<a href="#(resource)%20cache.regional_tiered_cache%20%3E%20(model)%20regional_tiered_cache_get_response%20%3E%20(schema)%20%3E%20(property)%20editable">Link to this property</a>

<details>

<summary>

value: Literal\["on", "off"]

Value of the Regional Tiered Cache zone setting.

</summary>

One of the following:

"on"

<a href="#(resource)%20cache.regional_tiered_cache%20%3E%20(model)%20regional_tiered_cache_get_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(member)%200">Link to this property</a>

"off"

<a href="#(resource)%20cache.regional_tiered_cache%20%3E%20(model)%20regional_tiered_cache_get_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20cache.regional_tiered_cache%20%3E%20(model)%20regional_tiered_cache_get_response%20%3E%20(schema)%20%3E%20(property)%20value">Link to this property</a>

modified\_on: Optional\[datetime]

Last time this setting was modified.

formatdate-time

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

</details>

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

<details>

<summary>

class RegionalTieredCacheEditResponse: …

</summary>

id: <a href="https://developers.cloudflare.com/api/python/resources/cache#(resource)%20cache.regional_tiered_cache%20%3E%20(model)%20regional_tiered_cache%20%3E%20(schema)">RegionalTieredCache</a>

The identifier of the caching setting.

<a href="#(resource)%20cache.regional_tiered_cache%20%3E%20(model)%20regional_tiered_cache_edit_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

editable: bool

Whether the setting is editable.

<a href="#(resource)%20cache.regional_tiered_cache%20%3E%20(model)%20regional_tiered_cache_edit_response%20%3E%20(schema)%20%3E%20(property)%20editable">Link to this property</a>

<details>

<summary>

value: Literal\["on", "off"]

Value of the Regional Tiered Cache zone setting.

</summary>

One of the following:

"on"

<a href="#(resource)%20cache.regional_tiered_cache%20%3E%20(model)%20regional_tiered_cache_edit_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(member)%200">Link to this property</a>

"off"

<a href="#(resource)%20cache.regional_tiered_cache%20%3E%20(model)%20regional_tiered_cache_edit_response%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20cache.regional_tiered_cache%20%3E%20(model)%20regional_tiered_cache_edit_response%20%3E%20(schema)%20%3E%20(property)%20value">Link to this property</a>

modified\_on: Optional\[datetime]

Last time this setting was modified.

formatdate-time

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

</details>

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

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