Skip to content
Cloudflare API
Start here
API Reference
Cache

Cache Reserve

Get Cache Reserve setting
cache.cache_reserve.get(CacheReserveGetParams**kwargs) -> CacheReserveGetResponse
GET/zones/{zone_id}/cache/cache_reserve
Change Cache Reserve setting
cache.cache_reserve.edit(CacheReserveEditParams**kwargs) -> CacheReserveEditResponse
PATCH/zones/{zone_id}/cache/cache_reserve
Get Cache Reserve Clear
cache.cache_reserve.status(CacheReserveStatusParams**kwargs) -> CacheReserveStatusResponse
GET/zones/{zone_id}/cache/cache_reserve_clear
Start Cache Reserve Clear
cache.cache_reserve.clear(CacheReserveClearParams**kwargs) -> CacheReserveClearResponse
POST/zones/{zone_id}/cache/cache_reserve_clear
ModelsExpand Collapse
Literal["cache_reserve"]

The identifier of the caching setting.

Literal["cache_reserve_clear"]

ID of the zone setting.

Literal["In-progress", "Completed"]

The current state of the Cache Reserve Clear operation.

One of the following:
"In-progress"
"Completed"
class CacheReserveGetResponse: …
id: CacheReserve

The identifier of the caching setting.

editable: bool

Whether the setting is editable.

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

Value of the Cache Reserve zone setting.

One of the following:
"on"
"off"
modified_on: Optional[datetime]

Last time this setting was modified.

formatdate-time
class CacheReserveEditResponse: …
id: CacheReserve

The identifier of the caching setting.

editable: bool

Whether the setting is editable.

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

Value of the Cache Reserve zone setting.

One of the following:
"on"
"off"
modified_on: Optional[datetime]

Last time this setting was modified.

formatdate-time
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.

id: CacheReserveClear

ID of the zone setting.

start_ts: datetime

The time that the latest Cache Reserve Clear operation started.

formatdate-time
state: State

The current state of the Cache Reserve Clear operation.

end_ts: Optional[datetime]

The time that the latest Cache Reserve Clear operation completed.

formatdate-time
modified_on: Optional[datetime]

Last time this setting was modified.

formatdate-time
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.

id: CacheReserveClear

ID of the zone setting.

start_ts: datetime

The time that the latest Cache Reserve Clear operation started.

formatdate-time
state: State

The current state of the Cache Reserve Clear operation.

end_ts: Optional[datetime]

The time that the latest Cache Reserve Clear operation completed.

formatdate-time
modified_on: Optional[datetime]

Last time this setting was modified.

formatdate-time