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

client.cache.originCloudRegions.list(OriginCloudRegionListParams { zone_id } params, RequestOptionsoptions?): OriginCloudRegionListResponse { id, editable, value, modified_on }

GET/zones/{zone_id}/cache/origin_cloud_regions

Create an origin cloud region mapping

client.cache.originCloudRegions.create(OriginCloudRegionCreateParams { zone_id, ip, region, vendor } params, RequestOptionsoptions?): OriginCloudRegionCreateResponse { id, editable, value, modified_on }

POST/zones/{zone_id}/cache/origin_cloud_regions

Create or update an origin cloud region mapping

client.cache.originCloudRegions.edit(OriginCloudRegionEditParams { zone_id, ip, region, vendor } params, RequestOptionsoptions?): OriginCloudRegionEditResponse { id, editable, value, modified_on }

PATCH/zones/{zone_id}/cache/origin_cloud_regions

Get an origin cloud region mapping

client.cache.originCloudRegions.get(stringoriginIP, OriginCloudRegionGetParams { zone_id } params, RequestOptionsoptions?): OriginCloudRegionGetResponse { id, editable, value, modified_on }

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

Delete an origin cloud region mapping

client.cache.originCloudRegions.delete(stringoriginIP, OriginCloudRegionDeleteParams { zone_id } params, RequestOptionsoptions?): OriginCloudRegionDeleteResponse { id, editable, value, modified_on }

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

Batch create or update origin cloud region mappings

client.cache.originCloudRegions.bulkEdit(OriginCloudRegionBulkEditParams { zone_id, body } params, RequestOptionsoptions?): OriginCloudRegionBulkEditResponse { id, editable, value, modified_on }

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

Batch delete origin cloud region mappings

client.cache.originCloudRegions.bulkDelete(OriginCloudRegionBulkDeleteParams { zone_id } params, RequestOptionsoptions?): OriginCloudRegionBulkDeleteResponse { id, editable, value, modified_on }

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

List supported cloud vendors and regions

client.cache.originCloudRegions.supportedRegions(OriginCloudRegionSupportedRegionsParams { zone_id } params, RequestOptionsoptions?): OriginCloudRegionSupportedRegionsResponse { obtained_codes, vendors }

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

ModelsExpand Collapse

OriginCloudRegion { 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" | "azure" | "gcp" | "oci"

Cloud vendor hosting the origin.

One of the following:

"aws"

"azure"

"gcp"

"oci"

modified_on?: string

Time this mapping was last modified.

formatdate-time

OriginCloudRegionListResponse { 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<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" | "azure" | "gcp" | "oci"

Cloud vendor hosting the origin.

One of the following:

"aws"

"azure"

"gcp"

"oci"

modified_on?: string

Time this mapping was last modified.

formatdate-time

modified_on?: string | null

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

formatdate-time

OriginCloudRegionCreateResponse { 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?: string

Time the mapping was last modified.

formatdate-time

OriginCloudRegionEditResponse { 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<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" | "azure" | "gcp" | "oci"

Cloud vendor hosting the origin.

One of the following:

"aws"

"azure"

"gcp"

"oci"

modified_on?: string

Time this mapping was last modified.

formatdate-time

modified_on?: string | null

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

formatdate-time

OriginCloudRegionGetResponse { 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?: string

Time the mapping was last modified.

formatdate-time

OriginCloudRegionDeleteResponse { 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?: string

Time the mapping was last modified.

formatdate-time

OriginCloudRegionBulkEditResponse { 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: Value { failed, succeeded }

failed: Array<Failed>

Items that could not be applied, with error details.

"origin-ip": string

The origin IP address for this item.

error?: string

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

region?: string

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

vendor?: string

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

succeeded: Array<Succeeded>

Items that were successfully applied.

"origin-ip": string

The origin IP address for this item.

error?: string

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

region?: string

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

vendor?: string

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

modified_on?: string | null

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

formatdate-time

OriginCloudRegionBulkDeleteResponse { 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: Value { failed, succeeded }

failed: Array<Failed>

Items that could not be applied, with error details.

"origin-ip": string

The origin IP address for this item.

error?: string

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

region?: string

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

vendor?: string

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

succeeded: Array<Succeeded>

Items that were successfully applied.

"origin-ip": string

The origin IP address for this item.

error?: string

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

region?: string

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

vendor?: string

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

modified_on?: string | null

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

formatdate-time

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.

vendors: Record<string, Array<Vendor>>

Map of vendor name to list of supported regions.

name: string

Cloud vendor region identifier.

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.