Origin Cloud Regions

List origin cloud region mappings

cache.origin_cloud_regions.list() -> SyncV4PagePaginationArray[OriginCloudRegion]

GET/zones/{zone_id}/origin/cloud_regions

Get an origin cloud region mapping

cache.origin_cloud_regions.get(, ) -> OriginCloudRegion

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

Create or replace an origin cloud region mapping

cache.origin_cloud_regions.update(, ) -> OriginCloudRegion

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

Delete an origin cloud region mapping

cache.origin_cloud_regions.delete(, ) -> OriginCloudRegionDeleteResponse

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

Batch create or replace origin cloud region mappings

cache.origin_cloud_regions.bulk_update() -> OriginCloudRegionBulkUpdateResponse

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

Batch delete origin cloud region mappings

cache.origin_cloud_regions.bulk_delete() -> OriginCloudRegionBulkDeleteResponse

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

List supported cloud vendors and regions

cache.origin_cloud_regions.supported_regions() -> OriginCloudRegionSupportedRegionsResponse

GET/zones/{zone_id}/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). Normalized to canonical form (RFC 5952 for IPv6).

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 OriginCloudRegionDeleteResponse: …

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

origin_ip: str

The origin IP address whose mapping was deleted.

class OriginCloudRegionBulkUpdateResponse: …

Response result for a batch origin cloud region operation.

failed: List[Failed]

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

vendor: Optional[str]

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

succeeded: List[Succeeded]

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

vendor: Optional[str]

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

class OriginCloudRegionBulkDeleteResponse: …

Response result for a batch origin cloud region operation.

failed: List[Failed]

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

vendor: Optional[str]

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

succeeded: List[Succeeded]

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

vendor: Optional[str]

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

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.