--- title: Cache --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) 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/typescript/resources/cache/methods/purge) client.cache.purge(CachePurgeParamsparams, RequestOptionsoptions?): [CachePurgeResponse]() {id } | null POST/zones/{zone\_id}/purge\_cache ##### [Purge Cached Content by Environment](https://developers.cloudflare.com/api/typescript/resources/cache/methods/purge_environment) client.cache.purgeEnvironment(stringenvironmentID, CachePurgeEnvironmentParamsparams, RequestOptionsoptions?): [CachePurgeEnvironmentResponse]() {id } | null POST/zones/{zone\_id}/environments/{environment\_id}/purge\_cache ##### [Invalidate Cached Content](https://developers.cloudflare.com/api/typescript/resources/cache/methods/invalidate) client.cache.invalidate(CacheInvalidateParamsparams, RequestOptionsoptions?): [CacheInvalidateResponse]() {id } | null POST/zones/{zone\_id}/invalidate\_cache ##### [Invalidate Cached Content by Environment](https://developers.cloudflare.com/api/typescript/resources/cache/methods/invalidate_environment) client.cache.invalidateEnvironment(stringenvironmentID, CacheInvalidateEnvironmentParamsparams, RequestOptionsoptions?): [CacheInvalidateEnvironmentResponse]() {id } | null POST/zones/{zone\_id}/environments/{environment\_id}/invalidate\_cache ##### ModelsExpand Collapse
CachePurgeResponse {id } id: string maxLength32 Link to this property
[Link to this property](<#(resource)%20cache%20%3E%20(model)%20cache_purge_response%20%3E%20(schema)>)
CachePurgeEnvironmentResponse {id } id: string maxLength32 Link to this property
[Link to this property](<#(resource)%20cache%20%3E%20(model)%20cache_purge_environment_response%20%3E%20(schema)>)
CacheInvalidateResponse {id } id: string maxLength32 Link to this property
[Link to this property](<#(resource)%20cache%20%3E%20(model)%20cache_invalidate_response%20%3E%20(schema)>)
CacheInvalidateEnvironmentResponse {id } id: string maxLength32 Link to this property
[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/typescript/resources/cache/subresources/cache_reserve/methods/get) 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](https://developers.cloudflare.com/api/typescript/resources/cache/subresources/cache_reserve/methods/edit) 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](https://developers.cloudflare.com/api/typescript/resources/cache/subresources/cache_reserve/methods/status) 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](https://developers.cloudflare.com/api/typescript/resources/cache/subresources/cache_reserve/methods/clear) client.cache.cacheReserve.clear(CacheReserveClearParams {zone\_id } 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. [Link to this property](<#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve%20%3E%20(schema)>) CacheReserveClear = "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)>)
CacheReserveGetResponse {id, editable, value, modified\_on } id: CacheReserve {} The identifier of the caching setting. Link to this property editable: boolean Whether the setting is editable. Link to this property
value: "on"| "off" Value of the Cache Reserve zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property modified\_on?: string| null Last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_get_response%20%3E%20(schema)>)
CacheReserveEditResponse {id, editable, value, modified\_on } id: CacheReserve {} The identifier of the caching setting. Link to this property editable: boolean Whether the setting is editable. Link to this property
value: "on"| "off" Value of the Cache Reserve zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property modified\_on?: string| null Last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_edit_response%20%3E%20(schema)>)
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. Link to this property start\_ts: string The time that the latest Cache Reserve Clear operation started. formatdate-time Link to this property
state: "In-progress"| "Completed" The current state of the Cache Reserve Clear operation. One of the following: "In-progress" Link to this property "Completed" Link to this property
Link to this property end\_ts?: string The time that the latest Cache Reserve Clear operation completed. formatdate-time Link to this property modified\_on?: string| null Last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20cache.cache_reserve%20%3E%20(model)%20cache_reserve_status_response%20%3E%20(schema)>)
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. Link to this property start\_ts: string The time that the latest Cache Reserve Clear operation started. formatdate-time Link to this property
state: "In-progress"| "Completed" The current state of the Cache Reserve Clear operation. One of the following: "In-progress" Link to this property "Completed" Link to this property
Link to this property end\_ts?: string The time that the latest Cache Reserve Clear operation completed. formatdate-time Link to this property modified\_on?: string| null Last time this setting was modified. formatdate-time Link to this property
[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/typescript/resources/cache/subresources/smart_tiered_cache/methods/get) client.cache.smartTieredCache.get(SmartTieredCacheGetParams {zone\_id } params, RequestOptionsoptions?): [SmartTieredCacheGetResponse]() {id, editable, value, modified\_on } GET/zones/{zone\_id}/cache/tiered\_cache\_smart\_topology\_enable ##### [Create Smart Tiered Cache setting](https://developers.cloudflare.com/api/typescript/resources/cache/subresources/smart_tiered_cache/methods/create) client.cache.smartTieredCache.create(SmartTieredCacheCreateParams {zone\_id, value } params, RequestOptionsoptions?): [SmartTieredCacheCreateResponse]() {id, editable, value, modified\_on } POST/zones/{zone\_id}/cache/tiered\_cache\_smart\_topology\_enable ##### [Patch Smart Tiered Cache setting](https://developers.cloudflare.com/api/typescript/resources/cache/subresources/smart_tiered_cache/methods/edit) client.cache.smartTieredCache.edit(SmartTieredCacheEditParams {zone\_id, value } params, RequestOptionsoptions?): [SmartTieredCacheEditResponse]() {id, editable, value, modified\_on } PATCH/zones/{zone\_id}/cache/tiered\_cache\_smart\_topology\_enable ##### [Delete Smart Tiered Cache setting](https://developers.cloudflare.com/api/typescript/resources/cache/subresources/smart_tiered_cache/methods/delete) client.cache.smartTieredCache.delete(SmartTieredCacheDeleteParams {zone\_id } params, RequestOptionsoptions?): [SmartTieredCacheDeleteResponse]() {id, editable, modified\_on } 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. Link to this property editable: boolean Whether the setting is editable. Link to this property
value: "on"| "off" Value of the Smart Tiered Cache zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property modified\_on?: string| null Last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20cache.smart_tiered_cache%20%3E%20(model)%20smart_tiered_cache_get_response%20%3E%20(schema)>)
SmartTieredCacheCreateResponse {id, editable, value, modified\_on } id: "tiered\_cache\_smart\_topology\_enable" The identifier of the caching setting. Link to this property editable: boolean Whether the setting is editable. Link to this property
value: "on"| "off" Value of the Smart Tiered Cache zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property modified\_on?: string| null Last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20cache.smart_tiered_cache%20%3E%20(model)%20smart_tiered_cache_create_response%20%3E%20(schema)>)
SmartTieredCacheEditResponse {id, editable, value, modified\_on } id: "tiered\_cache\_smart\_topology\_enable" The identifier of the caching setting. Link to this property editable: boolean Whether the setting is editable. Link to this property
value: "on"| "off" Value of the Smart Tiered Cache zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property modified\_on?: string| null Last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20cache.smart_tiered_cache%20%3E%20(model)%20smart_tiered_cache_edit_response%20%3E%20(schema)>)
SmartTieredCacheDeleteResponse {id, editable, modified\_on } id: "tiered\_cache\_smart\_topology\_enable" The identifier of the caching setting. Link to this property editable: boolean Whether the setting is editable. Link to this property modified\_on?: string| null Last time this setting was modified. formatdate-time Link to this property
[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/typescript/resources/cache/subresources/variants/methods/get) client.cache.variants.get(VariantGetParams {zone\_id } params, RequestOptionsoptions?): [VariantGetResponse]() {id, editable, value, modified\_on } GET/zones/{zone\_id}/cache/variants ##### [Change variants setting](https://developers.cloudflare.com/api/typescript/resources/cache/subresources/variants/methods/edit) client.cache.variants.edit(VariantEditParams {zone\_id, value } params, RequestOptionsoptions?): [VariantEditResponse]() {id, editable, value, modified\_on } PATCH/zones/{zone\_id}/cache/variants ##### [Delete variants setting](https://developers.cloudflare.com/api/typescript/resources/cache/subresources/variants/methods/delete) client.cache.variants.delete(VariantDeleteParams {zone\_id } params, RequestOptionsoptions?): [VariantDeleteResponse]() {id, editable, modified\_on } DELETE/zones/{zone\_id}/cache/variants ##### ModelsExpand Collapse
VariantGetResponse {id, editable, value, modified\_on } id: "variants" The identifier of the caching setting. Link to this property editable: boolean Whether the setting is editable. Link to this property
value: Value {avif, bmp, gif, 8 more } Value of the zone setting. avif?: Array<string> List of strings with the MIME types of all the variants that should be served for avif. Link to this property bmp?: Array<string> List of strings with the MIME types of all the variants that should be served for bmp. Link to this property gif?: Array<string> List of strings with the MIME types of all the variants that should be served for gif. Link to this property jp2?: Array<string> List of strings with the MIME types of all the variants that should be served for jp2. Link to this property jpeg?: Array<string> List of strings with the MIME types of all the variants that should be served for jpeg. Link to this property jpg?: Array<string> List of strings with the MIME types of all the variants that should be served for jpg. Link to this property jpg2?: Array<string> List of strings with the MIME types of all the variants that should be served for jpg2. Link to this property png?: Array<string> List of strings with the MIME types of all the variants that should be served for png. Link to this property tif?: Array<string> List of strings with the MIME types of all the variants that should be served for tif. Link to this property tiff?: Array<string> List of strings with the MIME types of all the variants that should be served for tiff. Link to this property webp?: Array<string> List of strings with the MIME types of all the variants that should be served for webp. Link to this property
Link to this property modified\_on?: string| null Last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20cache.variants%20%3E%20(model)%20variant_get_response%20%3E%20(schema)>)
VariantEditResponse {id, editable, value, modified\_on } id: "variants" The identifier of the caching setting. Link to this property editable: boolean Whether the setting is editable. Link to this property
value: Value {avif, bmp, gif, 8 more } Value of the zone setting. avif?: Array<string> List of strings with the MIME types of all the variants that should be served for avif. Link to this property bmp?: Array<string> List of strings with the MIME types of all the variants that should be served for bmp. Link to this property gif?: Array<string> List of strings with the MIME types of all the variants that should be served for gif. Link to this property jp2?: Array<string> List of strings with the MIME types of all the variants that should be served for jp2. Link to this property jpeg?: Array<string> List of strings with the MIME types of all the variants that should be served for jpeg. Link to this property jpg?: Array<string> List of strings with the MIME types of all the variants that should be served for jpg. Link to this property jpg2?: Array<string> List of strings with the MIME types of all the variants that should be served for jpg2. Link to this property png?: Array<string> List of strings with the MIME types of all the variants that should be served for png. Link to this property tif?: Array<string> List of strings with the MIME types of all the variants that should be served for tif. Link to this property tiff?: Array<string> List of strings with the MIME types of all the variants that should be served for tiff. Link to this property webp?: Array<string> List of strings with the MIME types of all the variants that should be served for webp. Link to this property
Link to this property modified\_on?: string| null Last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20cache.variants%20%3E%20(model)%20variant_edit_response%20%3E%20(schema)>)
VariantDeleteResponse {id, editable, modified\_on } id: "variants" The identifier of the caching setting. Link to this property editable: boolean Whether the setting is editable. Link to this property modified\_on?: string| null Last time this setting was modified. formatdate-time Link to this property
[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/typescript/resources/cache/subresources/regional_tiered_cache/methods/get) client.cache.regionalTieredCache.get(RegionalTieredCacheGetParams {zone\_id } params, RequestOptionsoptions?): [RegionalTieredCacheGetResponse]() {id, editable, value, modified\_on } GET/zones/{zone\_id}/cache/regional\_tiered\_cache ##### [Change Regional Tiered Cache setting](https://developers.cloudflare.com/api/typescript/resources/cache/subresources/regional_tiered_cache/methods/edit) client.cache.regionalTieredCache.edit(RegionalTieredCacheEditParams {zone\_id, value } params, RequestOptionsoptions?): [RegionalTieredCacheEditResponse]() {id, editable, value, modified\_on } PATCH/zones/{zone\_id}/cache/regional\_tiered\_cache ##### ModelsExpand Collapse RegionalTieredCache = "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)>)
RegionalTieredCacheGetResponse {id, editable, value, modified\_on } id: RegionalTieredCache {} The identifier of the caching setting. Link to this property editable: boolean Whether the setting is editable. Link to this property
value: "on"| "off" Value of the Regional Tiered Cache zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property modified\_on?: string| null Last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20cache.regional_tiered_cache%20%3E%20(model)%20regional_tiered_cache_get_response%20%3E%20(schema)>)
RegionalTieredCacheEditResponse {id, editable, value, modified\_on } id: RegionalTieredCache {} The identifier of the caching setting. Link to this property editable: boolean Whether the setting is editable. Link to this property
value: "on"| "off" Value of the Regional Tiered Cache zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property modified\_on?: string| null Last time this setting was modified. formatdate-time Link to this property
[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/typescript/resources/cache/subresources/origin_cloud_regions/methods/list) client.cache.originCloudRegions.list(OriginCloudRegionListParams {zone\_id, page, per\_page } params, RequestOptionsoptions?): V4PagePaginationArray< [OriginCloudRegionListResponse]() {origin\_ip, region, vendor, modified\_on } > GET/zones/{zone\_id}/origin/cloud\_regions ##### [Get an origin cloud region mapping](https://developers.cloudflare.com/api/typescript/resources/cache/subresources/origin_cloud_regions/methods/get) client.cache.originCloudRegions.get(stringoriginIP, OriginCloudRegionGetParams {zone\_id } params, RequestOptionsoptions?): [OriginCloudRegionGetResponse]() {origin\_ip, region, vendor, modified\_on } GET/zones/{zone\_id}/origin/cloud\_regions/{origin\_ip} ##### [Create or replace an origin cloud region mapping](https://developers.cloudflare.com/api/typescript/resources/cache/subresources/origin_cloud_regions/methods/update) client.cache.originCloudRegions.update(stringoriginIP, OriginCloudRegionUpdateParams {zone\_id, origin\_ip, region, vendor } params, RequestOptionsoptions?): [OriginCloudRegionUpdateResponse]() {origin\_ip, region, vendor, modified\_on } PUT/zones/{zone\_id}/origin/cloud\_regions/{origin\_ip} ##### [Delete an origin cloud region mapping](https://developers.cloudflare.com/api/typescript/resources/cache/subresources/origin_cloud_regions/methods/delete) client.cache.originCloudRegions.delete(stringoriginIP, OriginCloudRegionDeleteParams {zone\_id } params, RequestOptionsoptions?): [OriginCloudRegionDeleteResponse]() {origin\_ip } DELETE/zones/{zone\_id}/origin/cloud\_regions/{origin\_ip} ##### [Batch create or replace origin cloud region mappings](https://developers.cloudflare.com/api/typescript/resources/cache/subresources/origin_cloud_regions/methods/bulk_update) client.cache.originCloudRegions.bulkUpdate(OriginCloudRegionBulkUpdateParams {zone\_id, body } params, RequestOptionsoptions?): [OriginCloudRegionBulkUpdateResponse]() {failed, succeeded } PUT/zones/{zone\_id}/origin/cloud\_regions/batch ##### [Batch delete origin cloud region mappings](https://developers.cloudflare.com/api/typescript/resources/cache/subresources/origin_cloud_regions/methods/bulk_delete) client.cache.originCloudRegions.bulkDelete(OriginCloudRegionBulkDeleteParams {zone\_id } params, RequestOptionsoptions?): [OriginCloudRegionBulkDeleteResponse]() {failed, succeeded } DELETE/zones/{zone\_id}/origin/cloud\_regions/batch ##### [List supported cloud vendors and regions](https://developers.cloudflare.com/api/typescript/resources/cache/subresources/origin_cloud_regions/methods/supported_regions) client.cache.originCloudRegions.supportedRegions(OriginCloudRegionSupportedRegionsParams {zone\_id } params, RequestOptionsoptions?): [OriginCloudRegionSupportedRegionsResponse]() {obtained\_codes, vendors } GET/zones/{zone\_id}/origin/cloud\_regions/supported\_regions ##### ModelsExpand Collapse
OriginCloudRegionListResponse {origin\_ip, region, vendor, modified\_on } A single origin IP-to-cloud-region mapping. origin\_ip: string The origin IP address (IPv4 or IPv6). Normalized to canonical form (RFC 5952 for IPv6). Link to this property region: string Cloud vendor region identifier. Link to this property
vendor: "aws"| "azure"| "gcp"| "oci" Cloud vendor hosting the origin. One of the following: "aws" Link to this property "azure" Link to this property "gcp" Link to this property "oci" Link to this property
Link to this property modified\_on?: string Time this mapping was last modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_list_response%20%3E%20(schema)>)
OriginCloudRegionGetResponse {origin\_ip, region, vendor, modified\_on } A single origin IP-to-cloud-region mapping. origin\_ip: string The origin IP address (IPv4 or IPv6). Normalized to canonical form (RFC 5952 for IPv6). Link to this property region: string Cloud vendor region identifier. Link to this property
vendor: "aws"| "azure"| "gcp"| "oci" Cloud vendor hosting the origin. One of the following: "aws" Link to this property "azure" Link to this property "gcp" Link to this property "oci" Link to this property
Link to this property modified\_on?: string Time this mapping was last modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_get_response%20%3E%20(schema)>)
OriginCloudRegionUpdateResponse {origin\_ip, region, vendor, modified\_on } A single origin IP-to-cloud-region mapping. origin\_ip: string The origin IP address (IPv4 or IPv6). Normalized to canonical form (RFC 5952 for IPv6). Link to this property region: string Cloud vendor region identifier. Link to this property
vendor: "aws"| "azure"| "gcp"| "oci" Cloud vendor hosting the origin. One of the following: "aws" Link to this property "azure" Link to this property "gcp" Link to this property "oci" Link to this property
Link to this property modified\_on?: string Time this mapping was last modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_update_response%20%3E%20(schema)>)
OriginCloudRegionDeleteResponse {origin\_ip } Response result for a delete operation. Identifies the deleted mapping. origin\_ip: string The origin IP address whose mapping was deleted. Link to this property
[Link to this property](<#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_delete_response%20%3E%20(schema)>)
OriginCloudRegionBulkUpdateResponse {failed, succeeded } Response result for a batch origin cloud region operation.
failed: Array<Failed> Items that could not be applied, with error details. origin\_ip: string The origin IP address for this item. Link to this property error?: string Error message explaining why the item failed. Present only on failed items. Link to this property region?: string Cloud vendor region identifier. Present on succeeded items (the new value for upsert, the deleted value for delete). Link to this property vendor?: string Cloud vendor identifier. Present on succeeded items (the new value for upsert, the deleted value for delete). Link to this property
Link to this property
succeeded: Array<Succeeded> Items that were successfully applied. origin\_ip: string The origin IP address for this item. Link to this property error?: string Error message explaining why the item failed. Present only on failed items. Link to this property region?: string Cloud vendor region identifier. Present on succeeded items (the new value for upsert, the deleted value for delete). Link to this property vendor?: string Cloud vendor identifier. Present on succeeded items (the new value for upsert, the deleted value for delete). Link to this property
Link to this property
[Link to this property](<#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_bulk_update_response%20%3E%20(schema)>)
OriginCloudRegionBulkDeleteResponse {failed, succeeded } Response result for a batch origin cloud region operation.
failed: Array<Failed> Items that could not be applied, with error details. origin\_ip: string The origin IP address for this item. Link to this property error?: string Error message explaining why the item failed. Present only on failed items. Link to this property region?: string Cloud vendor region identifier. Present on succeeded items (the new value for upsert, the deleted value for delete). Link to this property vendor?: string Cloud vendor identifier. Present on succeeded items (the new value for upsert, the deleted value for delete). Link to this property
Link to this property
succeeded: Array<Succeeded> Items that were successfully applied. origin\_ip: string The origin IP address for this item. Link to this property error?: string Error message explaining why the item failed. Present only on failed items. Link to this property region?: string Cloud vendor region identifier. Present on succeeded items (the new value for upsert, the deleted value for delete). Link to this property vendor?: string Cloud vendor identifier. Present on succeeded items (the new value for upsert, the deleted value for delete). Link to this property
Link to this property
[Link to this property](<#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_bulk_delete_response%20%3E%20(schema)>)
OriginCloudRegionSupportedRegionsResponse {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. Link to this property
vendors: Record<string, Array<Vendor>> Map of vendor name to list of supported regions. name: string Cloud vendor region identifier. Link to this property upper\_tier\_colos: Array<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. Link to this property
Link to this property
[Link to this property](<#(resource)%20cache.origin_cloud_regions%20%3E%20(model)%20origin_cloud_region_supported_regions_response%20%3E%20(schema)>)