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

cache.origin_cloud_regions.list(OriginCloudRegionListParams**kwargs) -> OriginCloudRegionListResponse

GET/zones/{zone_id}/cache/origin_cloud_regions

Create an origin cloud region mapping

cache.origin_cloud_regions.create(OriginCloudRegionCreateParams**kwargs) -> OriginCloudRegionCreateResponse

POST/zones/{zone_id}/cache/origin_cloud_regions

Create or update an origin cloud region mapping

cache.origin_cloud_regions.edit(OriginCloudRegionEditParams**kwargs) -> OriginCloudRegionEditResponse

PATCH/zones/{zone_id}/cache/origin_cloud_regions

Get an origin cloud region mapping

cache.origin_cloud_regions.get(strorigin_ip, OriginCloudRegionGetParams**kwargs) -> OriginCloudRegionGetResponse

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

Delete an origin cloud region mapping

cache.origin_cloud_regions.delete(strorigin_ip, OriginCloudRegionDeleteParams**kwargs) -> OriginCloudRegionDeleteResponse

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

Batch create or update origin cloud region mappings

cache.origin_cloud_regions.bulk_edit(OriginCloudRegionBulkEditParams**kwargs) -> OriginCloudRegionBulkEditResponse

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

Batch delete origin cloud region mappings

cache.origin_cloud_regions.bulk_delete(OriginCloudRegionBulkDeleteParams**kwargs) -> OriginCloudRegionBulkDeleteResponse

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

List supported cloud vendors and regions

cache.origin_cloud_regions.supported_regions(OriginCloudRegionSupportedRegionsParams**kwargs) -> OriginCloudRegionSupportedRegionsResponse

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

ModelsExpand Collapse

class OriginCloudRegion: …

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

origin_ip: str

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

region: str

Cloud vendor region identifier.

vendor: Literal["aws", "azure", "gcp", "oci"]

Cloud vendor hosting the origin.

One of the following:

"aws"

"azure"

"gcp"

"oci"

modified_on: Optional[datetime]

Time this mapping was last modified.

formatdate-time

class OriginCloudRegionListResponse: …

Response result for a list of origin cloud region mappings.

id: Literal["origin_public_cloud_region"]

editable: bool

Whether the setting can be modified by the current user.

value: List[OriginCloudRegion]

origin_ip: str

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

region: str

Cloud vendor region identifier.

vendor: Literal["aws", "azure", "gcp", "oci"]

Cloud vendor hosting the origin.

One of the following:

"aws"

"azure"

"gcp"

"oci"

modified_on: Optional[datetime]

Time this mapping was last modified.

formatdate-time

modified_on: Optional[datetime]

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

formatdate-time

class OriginCloudRegionCreateResponse: …

Response result for a single origin cloud region mapping.

id: Literal["origin_public_cloud_region"]

editable: bool

Whether the setting can be modified by the current user.

value: OriginCloudRegion

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

modified_on: Optional[datetime]

Time the mapping was last modified.

formatdate-time

class OriginCloudRegionEditResponse: …

Response result for a list of origin cloud region mappings.

id: Literal["origin_public_cloud_region"]

editable: bool

Whether the setting can be modified by the current user.

value: List[OriginCloudRegion]

origin_ip: str

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

region: str

Cloud vendor region identifier.

vendor: Literal["aws", "azure", "gcp", "oci"]

Cloud vendor hosting the origin.

One of the following:

"aws"

"azure"

"gcp"

"oci"

modified_on: Optional[datetime]

Time this mapping was last modified.

formatdate-time

modified_on: Optional[datetime]

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

formatdate-time

class OriginCloudRegionGetResponse: …

Response result for a single origin cloud region mapping.

id: Literal["origin_public_cloud_region"]

editable: bool

Whether the setting can be modified by the current user.

value: OriginCloudRegion

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

modified_on: Optional[datetime]

Time the mapping was last modified.

formatdate-time

class OriginCloudRegionDeleteResponse: …

Response result for a single origin cloud region mapping.

id: Literal["origin_public_cloud_region"]

editable: bool

Whether the setting can be modified by the current user.

value: OriginCloudRegion

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

modified_on: Optional[datetime]

Time the mapping was last modified.

formatdate-time

class OriginCloudRegionBulkEditResponse: …

Response result for a batch origin cloud region operation.

id: Literal["origin_public_cloud_region"]

editable: bool

Whether the setting can be modified by the current user.

value: Value

failed: List[ValueFailed]

Items that could not be applied, with error details.

origin_ip: str

The origin IP address for this item.

error: Optional[str]

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

region: Optional[str]

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

vendor: Optional[str]

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

succeeded: List[ValueSucceeded]

Items that were successfully applied.

origin_ip: str

The origin IP address for this item.

error: Optional[str]

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

region: Optional[str]

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

vendor: Optional[str]

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

modified_on: Optional[datetime]

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

formatdate-time

class OriginCloudRegionBulkDeleteResponse: …

Response result for a batch origin cloud region operation.

id: Literal["origin_public_cloud_region"]

editable: bool

Whether the setting can be modified by the current user.

value: Value

failed: List[ValueFailed]

Items that could not be applied, with error details.

origin_ip: str

The origin IP address for this item.

error: Optional[str]

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

region: Optional[str]

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

vendor: Optional[str]

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

succeeded: List[ValueSucceeded]

Items that were successfully applied.

origin_ip: str

The origin IP address for this item.

error: Optional[str]

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

region: Optional[str]

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

vendor: Optional[str]

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

modified_on: Optional[datetime]

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

formatdate-time

class OriginCloudRegionSupportedRegionsResponse: …

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

obtained_codes: bool

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: Dict[str, List[Vendor]]

Map of vendor name to list of supported regions.

name: str

Cloud vendor region identifier.

upper_tier_colos: List[str]

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.