Skip to content
Start here

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

Adds a single IP-to-cloud-region mapping for the zone. The IP must be a valid IPv4 or IPv6 address and is normalized to canonical form before storage (RFC 5952 for IPv6). Returns 400 (code 1145) if a mapping for that IP already exists — use PATCH to update an existing entry. The vendor and region are validated against the list from GET /zones/{zone_id}/cache/origin_cloud_regions/supported_regions.

Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
ParametersExpand Collapse
params: OriginCloudRegionCreateParams { zone_id, ip, region, vendor }
zone_id: string

Path param: Identifier.

maxLength32
ip: string

Body param: Origin IP address (IPv4 or IPv6). Normalized to canonical form before storage (RFC 5952 for IPv6).

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.

One of the following:
"aws"
"azure"
"gcp"
"oci"
ReturnsExpand Collapse
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.

"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

Time the mapping was last modified.

formatdate-time

Create an origin cloud region mapping

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.create({
  zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
  ip: '192.0.2.1',
  region: 'us-east-1',
  vendor: 'aws',
});

console.log(originCloudRegion.id);
{
  "errors": [],
  "messages": [],
  "result": {
    "editable": true,
    "id": "origin_public_cloud_region",
    "modified_on": "2026-03-01T12:00:00Z",
    "value": {
      "modified_on": "2026-03-01T12:00:00Z",
      "origin-ip": "192.0.2.1",
      "region": "us-east-1",
      "vendor": "aws"
    }
  },
  "success": true
}
{
  "errors": [
    {
      "code": 1145,
      "message": "Unable to create new origin_public_cloud_region setting. The zone setting already exists."
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}
{
  "errors": [
    {
      "code": 1146,
      "message": "Invalid or missing origin IP address."
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}
{
  "errors": [
    {
      "code": 1157,
      "message": "The vendor provided doesn't exist or the region provided does not exist for the specified cloud vendor"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}
Returns Examples
{
  "errors": [],
  "messages": [],
  "result": {
    "editable": true,
    "id": "origin_public_cloud_region",
    "modified_on": "2026-03-01T12:00:00Z",
    "value": {
      "modified_on": "2026-03-01T12:00:00Z",
      "origin-ip": "192.0.2.1",
      "region": "us-east-1",
      "vendor": "aws"
    }
  },
  "success": true
}
{
  "errors": [
    {
      "code": 1145,
      "message": "Unable to create new origin_public_cloud_region setting. The zone setting already exists."
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}
{
  "errors": [
    {
      "code": 1146,
      "message": "Invalid or missing origin IP address."
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}
{
  "errors": [
    {
      "code": 1157,
      "message": "The vendor provided doesn't exist or the region provided does not exist for the specified cloud vendor"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}