API Reference

Cache

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Cache Reserve

Get Cache Reserve setting

client.cache.cacheReserve.get(CacheReserveGetParams { zone_id } params, RequestOptionsoptions?): CacheReserveGetResponse { id, editable, value, modified_on }

GET/zones/{zone_id}/cache/cache_reserve

Change Cache Reserve setting

client.cache.cacheReserve.edit(CacheReserveEditParams { zone_id, value } params, RequestOptionsoptions?): CacheReserveEditResponse { id, editable, value, modified_on }

PATCH/zones/{zone_id}/cache/cache_reserve

Get Cache Reserve Clear

client.cache.cacheReserve.status(CacheReserveStatusParams { zone_id } params, RequestOptionsoptions?): CacheReserveStatusResponse { id, start_ts, state, 2 more }

GET/zones/{zone_id}/cache/cache_reserve_clear

Start Cache Reserve Clear

client.cache.cacheReserve.clear(CacheReserveClearParams { zone_id, body } params, RequestOptionsoptions?): CacheReserveClearResponse { id, start_ts, state, 2 more }

POST/zones/{zone_id}/cache/cache_reserve_clear

ModelsExpand Collapse

CacheReserve = "cache_reserve"

The identifier of the caching setting.

CacheReserveClear = "cache_reserve_clear"

ID of the zone setting.

State = "In-progress" | "Completed"

The current state of the Cache Reserve Clear operation.

One of the following:

"In-progress"

"Completed"

CacheReserveGetResponse { id, editable, value, modified_on }

id: CacheReserve { }

The identifier of the caching setting.

editable: boolean

Whether the setting is editable.

value: "on" | "off"

Value of the Cache Reserve zone setting.

One of the following:

"on"

"off"

modified_on?: string | null

Last time this setting was modified.

formatdate-time

CacheReserveEditResponse { id, editable, value, modified_on }

id: CacheReserve { }

The identifier of the caching setting.

editable: boolean

Whether the setting is editable.

value: "on" | "off"

Value of the Cache Reserve zone setting.

One of the following:

"on"

"off"

modified_on?: string | null

Last time this setting was modified.

formatdate-time

CacheReserveStatusResponse { id, start_ts, state, 2 more }

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: string

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?: string

The time that the latest Cache Reserve Clear operation completed.

formatdate-time

modified_on?: string | null

Last time this setting was modified.

formatdate-time

CacheReserveClearResponse { id, start_ts, state, 2 more }

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: string

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?: string

The time that the latest Cache Reserve Clear operation completed.

formatdate-time

modified_on?: string | null

Last time this setting was modified.

formatdate-time