API Reference

Cache

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Origin Cloud Regions

List origin cloud region mappings

GET/zones/{zone_id}/origin/cloud_regions

Get an origin cloud region mapping

GET/zones/{zone_id}/origin/cloud_regions/{origin_ip}

Create or replace an origin cloud region mapping

PUT/zones/{zone_id}/origin/cloud_regions/{origin_ip}

Delete an origin cloud region mapping

DELETE/zones/{zone_id}/origin/cloud_regions/{origin_ip}

Batch create or replace origin cloud region mappings

PUT/zones/{zone_id}/origin/cloud_regions/batch

Batch delete origin cloud region mappings

DELETE/zones/{zone_id}/origin/cloud_regions/batch

List supported cloud vendors and regions

GET/zones/{zone_id}/origin/cloud_regions/supported_regions

List origin cloud region mappings

Deprecated

GET/zones/{zone_id}/cache/origin_cloud_regions

Create an origin cloud region mapping

Deprecated

POST/zones/{zone_id}/cache/origin_cloud_regions

Create or update an origin cloud region mapping

Deprecated

PATCH/zones/{zone_id}/cache/origin_cloud_regions

Get an origin cloud region mapping

Deprecated

GET/zones/{zone_id}/cache/origin_cloud_regions/{origin_ip}

Delete an origin cloud region mapping

Deprecated

DELETE/zones/{zone_id}/cache/origin_cloud_regions/{origin_ip}

Batch create or update origin cloud region mappings

Deprecated

PATCH/zones/{zone_id}/cache/origin_cloud_regions/batch

Batch delete origin cloud region mappings

Deprecated

DELETE/zones/{zone_id}/cache/origin_cloud_regions/batch

List supported cloud vendors and regions

Deprecated

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). Normalized to canonical form (RFC 5952 for IPv6).

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

OriginCloudRegionDeleteResponse object { origin_ip }

Response result for a delete operation. Identifies the deleted mapping.

origin_ip: string

The origin IP address whose mapping was deleted.

OriginCloudRegionBulkUpdateResponse object { failed, succeeded }

Response result for a batch origin cloud region operation.

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 (the new value for upsert, the deleted value for delete).

vendor: optional string

Cloud vendor identifier. Present on succeeded items (the new value for upsert, the deleted value for delete).

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 (the new value for upsert, the deleted value for delete).

vendor: optional string

Cloud vendor identifier. Present on succeeded items (the new value for upsert, the deleted value for delete).

OriginCloudRegionBulkDeleteResponse object { failed, succeeded }

Response result for a batch origin cloud region operation.

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 (the new value for upsert, the deleted value for delete).

vendor: optional string

Cloud vendor identifier. Present on succeeded items (the new value for upsert, the deleted value for delete).

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 (the new value for upsert, the deleted value for delete).

vendor: optional string

Cloud vendor identifier. Present on succeeded items (the new value for upsert, the deleted value for delete).

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.

OriginCloudRegionListV1Response 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 object { "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

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

modified_on: optional string

Time the mapping was last modified.

formatdate-time

OriginCloudRegionEditV1Response 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 object { "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

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

modified_on: optional string

Time the mapping was last modified.

formatdate-time

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

modified_on: optional string

Time the mapping was last modified.

formatdate-time

OriginCloudRegionBulkEditV1Response 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

OriginCloudRegionBulkDeleteV1Response 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

OriginCloudRegionSupportedRegionsV1Response 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.