Skip to content
Start here

Cache

Purge Cached Content
POST/zones/{zone_id}/purge_cache
ModelsExpand Collapse
CachePurgeResponse { id }
id: string
maxLength32

CacheCache Reserve

Get Cache Reserve setting
GET/zones/{zone_id}/cache/cache_reserve
Change Cache Reserve setting
PATCH/zones/{zone_id}/cache/cache_reserve
Get Cache Reserve Clear
GET/zones/{zone_id}/cache/cache_reserve_clear
Start Cache Reserve Clear
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" or "Completed"

The current state of the Cache Reserve Clear operation.

One of the following:
"In-progress"
"Completed"
CacheReserveGetResponse { id, editable, value, modified_on }

The identifier of the caching setting.

editable: boolean

Whether the setting is editable.

value: "on" or "off"

Value of the Cache Reserve zone setting.

One of the following:
"on"
"off"
modified_on: optional string

Last time this setting was modified.

formatdate-time
CacheReserveEditResponse { id, editable, value, modified_on }

The identifier of the caching setting.

editable: boolean

Whether the setting is editable.

value: "on" or "off"

Value of the Cache Reserve zone setting.

One of the following:
"on"
"off"
modified_on: optional string

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

The time that the latest Cache Reserve Clear operation completed.

formatdate-time
modified_on: optional string

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

The time that the latest Cache Reserve Clear operation completed.

formatdate-time
modified_on: optional string

Last time this setting was modified.

formatdate-time

CacheSmart Tiered Cache

Get Smart Tiered Cache setting
GET/zones/{zone_id}/cache/tiered_cache_smart_topology_enable
Patch Smart Tiered Cache setting
PATCH/zones/{zone_id}/cache/tiered_cache_smart_topology_enable
Delete Smart Tiered Cache setting
DELETE/zones/{zone_id}/cache/tiered_cache_smart_topology_enable
ModelsExpand Collapse
SmartTieredCacheGetResponse { id, editable, value, modified_on }
id: "tiered_cache_smart_topology_enable"

The identifier of the caching setting.

editable: boolean

Whether the setting is editable.

value: "on" or "off"

Value of the Smart Tiered Cache zone setting.

One of the following:
"on"
"off"
modified_on: optional string

Last time this setting was modified.

formatdate-time
SmartTieredCacheEditResponse { id, editable, value, modified_on }
id: "tiered_cache_smart_topology_enable"

The identifier of the caching setting.

editable: boolean

Whether the setting is editable.

value: "on" or "off"

Value of the Smart Tiered Cache zone setting.

One of the following:
"on"
"off"
modified_on: optional string

Last time this setting was modified.

formatdate-time
SmartTieredCacheDeleteResponse { id, editable, modified_on }
id: "tiered_cache_smart_topology_enable"

The identifier of the caching setting.

editable: boolean

Whether the setting is editable.

modified_on: optional string

Last time this setting was modified.

formatdate-time

CacheVariants

Get variants setting
GET/zones/{zone_id}/cache/variants
Change variants setting
PATCH/zones/{zone_id}/cache/variants
Delete variants setting
DELETE/zones/{zone_id}/cache/variants
ModelsExpand Collapse
CacheVariant { id, modified_on }

Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the ‘Vary: Accept’ response header. If the origin server sends ‘Vary: Accept’ but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.

id: "variants"

ID of the zone setting.

modified_on: optional string

Last time this setting was modified.

formatdate-time
VariantGetResponse { id, editable, value, modified_on }
id: "variants"

The identifier of the caching setting.

editable: boolean

Whether the setting is editable.

value: { avif, bmp, gif, 8 more }

Value of the zone setting.

avif: optional array of string

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

bmp: optional array of string

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

gif: optional array of string

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

jp2: optional array of string

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

jpeg: optional array of string

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

jpg: optional array of string

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

jpg2: optional array of string

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

png: optional array of string

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

tif: optional array of string

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

tiff: optional array of string

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

webp: optional array of string

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

modified_on: optional string

Last time this setting was modified.

formatdate-time
VariantEditResponse { id, editable, value, modified_on }
id: "variants"

The identifier of the caching setting.

editable: boolean

Whether the setting is editable.

value: { avif, bmp, gif, 8 more }

Value of the zone setting.

avif: optional array of string

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

bmp: optional array of string

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

gif: optional array of string

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

jp2: optional array of string

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

jpeg: optional array of string

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

jpg: optional array of string

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

jpg2: optional array of string

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

png: optional array of string

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

tif: optional array of string

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

tiff: optional array of string

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

webp: optional array of string

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

modified_on: optional string

Last time this setting was modified.

formatdate-time
VariantDeleteResponse { id, editable, modified_on }
id: "variants"

The identifier of the caching setting.

editable: boolean

Whether the setting is editable.

modified_on: optional string

Last time this setting was modified.

formatdate-time

CacheRegional Tiered Cache

Get Regional Tiered Cache setting
GET/zones/{zone_id}/cache/regional_tiered_cache
Change Regional Tiered Cache setting
PATCH/zones/{zone_id}/cache/regional_tiered_cache
ModelsExpand Collapse
RegionalTieredCache = "tc_regional"

The identifier of the caching setting.

RegionalTieredCacheGetResponse { id, editable, value, modified_on }

The identifier of the caching setting.

editable: boolean

Whether the setting is editable.

value: "on" or "off"

Value of the Regional Tiered Cache zone setting.

One of the following:
"on"
"off"
modified_on: optional string

Last time this setting was modified.

formatdate-time
RegionalTieredCacheEditResponse { id, editable, value, modified_on }

The identifier of the caching setting.

editable: boolean

Whether the setting is editable.

value: "on" or "off"

Value of the Regional Tiered Cache zone setting.

One of the following:
"on"
"off"
modified_on: optional string

Last time this setting was modified.

formatdate-time