Skip to content
Start here

Cache

Purge Cached Content
POST/zones/{zone_id}/purge_cache
ModelsExpand Collapse
CachePurgeResponse object { 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 object { 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 object { 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 object { 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 object { 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 object { 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 object { 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 object { 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 object { 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 object { id, editable, value, modified_on }
id: "variants"

The identifier of the caching setting.

editable: boolean

Whether the setting is editable.

value: object { 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 object { id, editable, value, modified_on }
id: "variants"

The identifier of the caching setting.

editable: boolean

Whether the setting is editable.

value: object { 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 object { 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 object { 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 object { 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

CacheOrigin Cloud Regions

List origin cloud region mappings
GET/zones/{zone_id}/cache/origin_cloud_regions
Create an origin cloud region mapping
POST/zones/{zone_id}/cache/origin_cloud_regions
Create or update an origin cloud region mapping
PATCH/zones/{zone_id}/cache/origin_cloud_regions
Get an origin cloud region mapping
GET/zones/{zone_id}/cache/origin_cloud_regions/{origin_ip}
Delete an origin cloud region mapping
DELETE/zones/{zone_id}/cache/origin_cloud_regions/{origin_ip}
Batch create or update origin cloud region mappings
PATCH/zones/{zone_id}/cache/origin_cloud_regions/batch
Batch delete origin cloud region mappings
DELETE/zones/{zone_id}/cache/origin_cloud_regions/batch
List supported cloud vendors and regions
GET/zones/{zone_id}/cache/origin_cloud_regions/supported_regions
ModelsExpand Collapse
OriginCloudRegion object { "origin-ip", region, vendor, modified_on }

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

"origin-ip": string

The origin IP address (IPv4 or IPv6, canonicalized).

region: string

Cloud vendor region identifier.

vendor: "aws" or "azure" or "gcp" or "oci"

Cloud vendor hosting the origin.

One of the following:
"aws"
"azure"
"gcp"
"oci"
modified_on: optional string

Time this mapping was last modified.

formatdate-time
OriginCloudRegionListResponse object { id, editable, value, modified_on }

Response result for a list of origin cloud region mappings.

id: "origin_public_cloud_region"
editable: boolean

Whether the setting can be modified by the current user.

value: array of OriginCloudRegion { origin-ip, region, vendor, modified_on }
"origin-ip": string

The origin IP address (IPv4 or IPv6, canonicalized).

region: string

Cloud vendor region identifier.

vendor: "aws" or "azure" or "gcp" or "oci"

Cloud vendor hosting the origin.

One of the following:
"aws"
"azure"
"gcp"
"oci"
modified_on: optional string

Time this mapping was last modified.

formatdate-time
modified_on: optional string

Time the mapping set was last modified. Null when no mappings exist.

formatdate-time
OriginCloudRegionCreateResponse object { id, editable, value, modified_on }

Response result for a single origin cloud region mapping.

id: "origin_public_cloud_region"
editable: boolean

Whether the setting can be modified by the current user.

value: OriginCloudRegion { origin-ip, region, vendor, modified_on }

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

modified_on: optional string

Time the mapping was last modified.

formatdate-time
OriginCloudRegionEditResponse object { id, editable, value, modified_on }

Response result for a list of origin cloud region mappings.

id: "origin_public_cloud_region"
editable: boolean

Whether the setting can be modified by the current user.

value: array of OriginCloudRegion { origin-ip, region, vendor, modified_on }
"origin-ip": string

The origin IP address (IPv4 or IPv6, canonicalized).

region: string

Cloud vendor region identifier.

vendor: "aws" or "azure" or "gcp" or "oci"

Cloud vendor hosting the origin.

One of the following:
"aws"
"azure"
"gcp"
"oci"
modified_on: optional string

Time this mapping was last modified.

formatdate-time
modified_on: optional string

Time the mapping set was last modified. Null when no mappings exist.

formatdate-time
OriginCloudRegionGetResponse object { id, editable, value, modified_on }

Response result for a single origin cloud region mapping.

id: "origin_public_cloud_region"
editable: boolean

Whether the setting can be modified by the current user.

value: OriginCloudRegion { origin-ip, region, vendor, modified_on }

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

modified_on: optional string

Time the mapping was last modified.

formatdate-time
OriginCloudRegionDeleteResponse object { id, editable, value, modified_on }

Response result for a single origin cloud region mapping.

id: "origin_public_cloud_region"
editable: boolean

Whether the setting can be modified by the current user.

value: OriginCloudRegion { origin-ip, region, vendor, modified_on }

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

modified_on: optional string

Time the mapping was last modified.

formatdate-time
OriginCloudRegionBulkEditResponse object { id, editable, value, modified_on }

Response result for a batch origin cloud region operation.

id: "origin_public_cloud_region"
editable: boolean

Whether the setting can be modified by the current user.

value: object { failed, succeeded }
failed: array of object { "origin-ip", error, region, vendor }

Items that could not be applied, with error details.

"origin-ip": string

The origin IP address for this item.

error: optional string

Error message explaining why the item failed. Present only on failed items.

region: optional string

Cloud vendor region identifier. Present on succeeded items for patch operations.

vendor: optional string

Cloud vendor identifier. Present on succeeded items for patch operations.

succeeded: array of object { "origin-ip", error, region, vendor }

Items that were successfully applied.

"origin-ip": string

The origin IP address for this item.

error: optional string

Error message explaining why the item failed. Present only on failed items.

region: optional string

Cloud vendor region identifier. Present on succeeded items for patch operations.

vendor: optional string

Cloud vendor identifier. Present on succeeded items for patch operations.

modified_on: optional string

Time the mapping set was last modified. Null when no items were successfully applied.

formatdate-time
OriginCloudRegionBulkDeleteResponse object { id, editable, value, modified_on }

Response result for a batch origin cloud region operation.

id: "origin_public_cloud_region"
editable: boolean

Whether the setting can be modified by the current user.

value: object { failed, succeeded }
failed: array of object { "origin-ip", error, region, vendor }

Items that could not be applied, with error details.

"origin-ip": string

The origin IP address for this item.

error: optional string

Error message explaining why the item failed. Present only on failed items.

region: optional string

Cloud vendor region identifier. Present on succeeded items for patch operations.

vendor: optional string

Cloud vendor identifier. Present on succeeded items for patch operations.

succeeded: array of object { "origin-ip", error, region, vendor }

Items that were successfully applied.

"origin-ip": string

The origin IP address for this item.

error: optional string

Error message explaining why the item failed. Present only on failed items.

region: optional string

Cloud vendor region identifier. Present on succeeded items for patch operations.

vendor: optional string

Cloud vendor identifier. Present on succeeded items for patch operations.

modified_on: optional string

Time the mapping set was last modified. Null when no items were successfully applied.

formatdate-time
OriginCloudRegionSupportedRegionsResponse object { obtained_codes, vendors }

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

obtained_codes: boolean

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

vendors: map[array of object { name, upper_tier_colos } ]

Map of vendor name to list of supported regions.

name: string

Cloud vendor region identifier.

upper_tier_colos: array of string

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.