# Origin Cloud Regions ## List origin cloud region mappings `client.cache.originCloudRegions.list(OriginCloudRegionListParamsparams, RequestOptionsoptions?): V4PagePaginationArray` **get** `/zones/{zone_id}/origin/cloud_regions` Returns all IP-to-cloud-region mappings configured for the zone with pagination support. Each mapping tells Cloudflare which cloud vendor and region hosts the origin at that IP, enabling the edge to route via the nearest Tiered Cache upper-tier co-located with that cloud provider. Returns an empty array when no mappings exist. ### Parameters - `params: OriginCloudRegionListParams` - `zone_id: string` Path param: Identifier. - `page?: number` Query param: Page number of paginated results. - `per_page?: number` Query param: Number of items per page. ### Returns - `OriginCloudRegion` 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" | "azure" | "gcp" | "oci"` Cloud vendor hosting the origin. - `"aws"` - `"azure"` - `"gcp"` - `"oci"` - `modified_on?: string` Time this mapping was last modified. ### Example ```node import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const originCloudRegion of client.cache.originCloudRegions.list({ zone_id: '023e105f4ecef8ad9ca31a8372d0c353', })) { console.log(originCloudRegion.origin_ip); } ``` #### Response ```json { "errors": [], "messages": [], "result": [], "result_info": { "count": 0, "page": 1, "per_page": 20, "total_count": 0, "total_pages": 0 }, "success": true } ``` ## Get an origin cloud region mapping `client.cache.originCloudRegions.get(stringoriginIP, OriginCloudRegionGetParamsparams, RequestOptionsoptions?): OriginCloudRegion` **get** `/zones/{zone_id}/origin/cloud_regions/{origin_ip}` Returns the cloud region mapping for a single origin IP address. The IP path parameter is normalized before lookup (RFC 5952 for IPv6). Returns 404 if the zone has no mappings or if the specified IP has no mapping. ### Parameters - `originIP: string` - `params: OriginCloudRegionGetParams` - `zone_id: string` Identifier. ### Returns - `OriginCloudRegion` 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" | "azure" | "gcp" | "oci"` Cloud vendor hosting the origin. - `"aws"` - `"azure"` - `"gcp"` - `"oci"` - `modified_on?: string` Time this mapping was last modified. ### Example ```node import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const originCloudRegion = await client.cache.originCloudRegions.get('192.0.2.1', { zone_id: '023e105f4ecef8ad9ca31a8372d0c353', }); console.log(originCloudRegion.origin_ip); ``` #### Response ```json { "errors": [], "messages": [], "result": { "modified_on": "2026-03-01T12:00:00Z", "origin_ip": "192.0.2.1", "region": "us-east-1", "vendor": "aws" }, "success": true } ``` ## Create or replace an origin cloud region mapping `client.cache.originCloudRegions.update(stringoriginIP, OriginCloudRegionUpdateParamsparams, RequestOptionsoptions?): OriginCloudRegion` **put** `/zones/{zone_id}/origin/cloud_regions/{origin_ip}` Creates a new IP-to-cloud-region mapping or replaces the existing mapping for the specified IP. PUT is idempotent — calling it repeatedly with the same body produces the same result. The IP path parameter is normalized to canonical form (RFC 5952 for IPv6) before storage. The vendor and region are validated against the list from `GET /zones/{zone_id}/origin/cloud_regions/supported_regions`. Returns 400 if the `origin_ip` in the body does not match the URL path parameter. Returns 403 (code 1164) when the zone has reached the limit of 3,500 IP mappings. ### Parameters - `originIP: string` - `params: OriginCloudRegionUpdateParams` - `zone_id: string` Path param: Identifier. - `origin_ip: string` Body param: Origin IP address (IPv4 or IPv6). For the single PUT endpoint (`PUT /origin/cloud_regions/{origin_ip}`), this field must match the path parameter or the request will be rejected with a 400 error. For the batch PUT endpoint, this field identifies which mapping to upsert. - `region: string` Body param: Cloud vendor region identifier. Must be a valid region for the specified vendor as returned by the supported_regions endpoint. - `vendor: "aws" | "azure" | "gcp" | "oci"` Body param: Cloud vendor hosting the origin. Must be one of the supported vendors. - `"aws"` - `"azure"` - `"gcp"` - `"oci"` ### Returns - `OriginCloudRegion` 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" | "azure" | "gcp" | "oci"` Cloud vendor hosting the origin. - `"aws"` - `"azure"` - `"gcp"` - `"oci"` - `modified_on?: string` Time this mapping was last modified. ### Example ```node import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const originCloudRegion = await client.cache.originCloudRegions.update('192.0.2.1', { zone_id: '023e105f4ecef8ad9ca31a8372d0c353', origin_ip: '192.0.2.1', region: 'us-east-1', vendor: 'aws', }); console.log(originCloudRegion.origin_ip); ``` #### Response ```json { "errors": [], "messages": [], "result": { "modified_on": "2026-03-01T12:00:00Z", "origin_ip": "192.0.2.1", "region": "us-east-1", "vendor": "aws" }, "success": true } ``` ## Delete an origin cloud region mapping `client.cache.originCloudRegions.delete(stringoriginIP, OriginCloudRegionDeleteParamsparams, RequestOptionsoptions?): OriginCloudRegionDeleteResponse` **delete** `/zones/{zone_id}/origin/cloud_regions/{origin_ip}` Removes the cloud region mapping for a single origin IP address. The IP path parameter is normalized before lookup. Returns the deleted IP on success. Returns 404 if no mapping exists for the specified IP. When the last mapping for the zone is removed the underlying rule record is also deleted. ### Parameters - `originIP: string` - `params: OriginCloudRegionDeleteParams` - `zone_id: string` Identifier. ### Returns - `OriginCloudRegionDeleteResponse` Response result for a delete operation. Identifies the deleted mapping. - `origin_ip: string` The origin IP address whose mapping was deleted. ### Example ```node import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const originCloudRegion = await client.cache.originCloudRegions.delete('192.0.2.1', { zone_id: '023e105f4ecef8ad9ca31a8372d0c353', }); console.log(originCloudRegion.origin_ip); ``` #### Response ```json { "errors": [], "messages": [], "result": { "origin_ip": "192.0.2.1" }, "success": true } ``` ## Batch create or replace origin cloud region mappings `client.cache.originCloudRegions.bulkUpdate(OriginCloudRegionBulkUpdateParamsparams, RequestOptionsoptions?): OriginCloudRegionBulkUpdateResponse` **put** `/zones/{zone_id}/origin/cloud_regions/batch` Upserts up to 100 IP-to-cloud-region mappings in a single request. Items in the request body are created or replaced; mappings not included in the request body are preserved unchanged (this is a merge operation, not a full collection replacement). Each item is validated independently — valid items are applied and invalid items are returned in the `failed` array. The vendor and region for every item are validated against the list from `GET /zones/{zone_id}/origin/cloud_regions/supported_regions`. ### Parameters - `params: OriginCloudRegionBulkUpdateParams` - `zone_id: string` Path param: Identifier. - `body: Array` Body param - `origin_ip: string` Origin IP address (IPv4 or IPv6). For the single PUT endpoint (`PUT /origin/cloud_regions/{origin_ip}`), this field must match the path parameter or the request will be rejected with a 400 error. For the batch PUT endpoint, this field identifies which mapping to upsert. - `region: string` Cloud vendor region identifier. Must be a valid region for the specified vendor as returned by the supported_regions endpoint. - `vendor: "aws" | "azure" | "gcp" | "oci"` Cloud vendor hosting the origin. Must be one of the supported vendors. - `"aws"` - `"azure"` - `"gcp"` - `"oci"` ### Returns - `OriginCloudRegionBulkUpdateResponse` Response result for a batch origin cloud region operation. - `failed: Array` 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 (the new value for upsert, the deleted value for delete). - `vendor?: string` Cloud vendor identifier. Present on succeeded items (the new value for upsert, the deleted value for delete). - `succeeded: Array` 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 (the new value for upsert, the deleted value for delete). - `vendor?: string` Cloud vendor identifier. Present on succeeded items (the new value for upsert, the deleted value for delete). ### Example ```node import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const response = await client.cache.originCloudRegions.bulkUpdate({ zone_id: '023e105f4ecef8ad9ca31a8372d0c353', body: [ { origin_ip: '192.0.2.1', region: 'us-east-1', vendor: 'aws', }, { origin_ip: '2001:db8::1', region: 'us-central1', vendor: 'gcp', }, ], }); console.log(response.failed); ``` #### Response ```json { "errors": [], "messages": [], "result": { "failed": [], "succeeded": [ { "origin_ip": "192.0.2.1", "region": "us-east-1", "vendor": "aws" }, { "origin_ip": "2001:db8::1", "region": "us-central1", "vendor": "gcp" } ] }, "success": true } ``` ## Batch delete origin cloud region mappings `client.cache.originCloudRegions.bulkDelete(OriginCloudRegionBulkDeleteParamsparams, RequestOptionsoptions?): OriginCloudRegionBulkDeleteResponse` **delete** `/zones/{zone_id}/origin/cloud_regions/batch` Removes up to 100 IP-to-cloud-region mappings in a single request. Each IP is validated independently — successfully deleted items are returned in the `succeeded` array and IPs that could not be found or are invalid are returned in the `failed` array. ### Parameters - `params: OriginCloudRegionBulkDeleteParams` - `zone_id: string` Identifier. ### Returns - `OriginCloudRegionBulkDeleteResponse` Response result for a batch origin cloud region operation. - `failed: Array` 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 (the new value for upsert, the deleted value for delete). - `vendor?: string` Cloud vendor identifier. Present on succeeded items (the new value for upsert, the deleted value for delete). - `succeeded: Array` 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 (the new value for upsert, the deleted value for delete). - `vendor?: string` Cloud vendor identifier. Present on succeeded items (the new value for upsert, the deleted value for delete). ### Example ```node import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const response = await client.cache.originCloudRegions.bulkDelete({ zone_id: '023e105f4ecef8ad9ca31a8372d0c353', }); console.log(response.failed); ``` #### Response ```json { "errors": [], "messages": [], "result": { "failed": [], "succeeded": [ { "origin_ip": "192.0.2.1", "region": "us-east-1", "vendor": "aws" }, { "origin_ip": "2001:db8::1", "region": "us-central1", "vendor": "gcp" } ] }, "success": true } ``` ## List supported cloud vendors and regions `client.cache.originCloudRegions.supportedRegions(OriginCloudRegionSupportedRegionsParamsparams, RequestOptionsoptions?): OriginCloudRegionSupportedRegionsResponse` **get** `/zones/{zone_id}/origin/cloud_regions/supported_regions` Returns the cloud vendors and regions that are valid values for origin cloud region mappings. Each region includes the Tiered Cache upper-tier colocation codes that will be used for cache routing when a mapping targeting that region is active. Requires the zone to have Tiered Cache enabled. ### Parameters - `params: OriginCloudRegionSupportedRegionsParams` - `zone_id: string` Identifier. ### Returns - `OriginCloudRegionSupportedRegionsResponse` 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>` Map of vendor name to list of supported regions. - `name: string` Cloud vendor region identifier. - `upper_tier_colos: Array` 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. ### Example ```node import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const response = await client.cache.originCloudRegions.supportedRegions({ zone_id: '023e105f4ecef8ad9ca31a8372d0c353', }); console.log(response.obtained_codes); ``` #### Response ```json { "errors": [], "messages": [], "result": { "obtained_codes": true, "vendors": { "aws": [ { "name": "us-east-1", "upper_tier_colos": [ "IAD", "EWR" ] }, { "name": "us-west-2", "upper_tier_colos": [ "SEA" ] } ], "gcp": [ { "name": "us-central1", "upper_tier_colos": [ "ORD" ] } ] } }, "success": true } ``` ## Domain Types ### Origin Cloud Region - `OriginCloudRegion` 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" | "azure" | "gcp" | "oci"` Cloud vendor hosting the origin. - `"aws"` - `"azure"` - `"gcp"` - `"oci"` - `modified_on?: string` Time this mapping was last modified. ### Origin Cloud Region Delete Response - `OriginCloudRegionDeleteResponse` Response result for a delete operation. Identifies the deleted mapping. - `origin_ip: string` The origin IP address whose mapping was deleted. ### Origin Cloud Region Bulk Update Response - `OriginCloudRegionBulkUpdateResponse` Response result for a batch origin cloud region operation. - `failed: Array` 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 (the new value for upsert, the deleted value for delete). - `vendor?: string` Cloud vendor identifier. Present on succeeded items (the new value for upsert, the deleted value for delete). - `succeeded: Array` 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 (the new value for upsert, the deleted value for delete). - `vendor?: string` Cloud vendor identifier. Present on succeeded items (the new value for upsert, the deleted value for delete). ### Origin Cloud Region Bulk Delete Response - `OriginCloudRegionBulkDeleteResponse` Response result for a batch origin cloud region operation. - `failed: Array` 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 (the new value for upsert, the deleted value for delete). - `vendor?: string` Cloud vendor identifier. Present on succeeded items (the new value for upsert, the deleted value for delete). - `succeeded: Array` 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 (the new value for upsert, the deleted value for delete). - `vendor?: string` Cloud vendor identifier. Present on succeeded items (the new value for upsert, the deleted value for delete). ### Origin Cloud Region Supported Regions Response - `OriginCloudRegionSupportedRegionsResponse` 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>` Map of vendor name to list of supported regions. - `name: string` Cloud vendor region identifier. - `upper_tier_colos: Array` 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.