Skip to content
Cloudflare API
Start here
API Reference
Addressing

Regional Hostnames

List Regional Hostnames
addressing.regional_hostnames.list(RegionalHostnameListParams**kwargs) -> SyncSinglePage[RegionalHostnameListResponse]
GET/zones/{zone_id}/addressing/regional_hostnames
Fetch Regional Hostname
addressing.regional_hostnames.get(strhostname, RegionalHostnameGetParams**kwargs) -> RegionalHostnameGetResponse
GET/zones/{zone_id}/addressing/regional_hostnames/{hostname}
Create Regional Hostname
addressing.regional_hostnames.create(RegionalHostnameCreateParams**kwargs) -> RegionalHostnameCreateResponse
POST/zones/{zone_id}/addressing/regional_hostnames
Update Regional Hostname
addressing.regional_hostnames.edit(strhostname, RegionalHostnameEditParams**kwargs) -> RegionalHostnameEditResponse
PATCH/zones/{zone_id}/addressing/regional_hostnames/{hostname}
Delete Regional Hostname
addressing.regional_hostnames.delete(strhostname, RegionalHostnameDeleteParams**kwargs) -> RegionalHostnameDeleteResponse
DELETE/zones/{zone_id}/addressing/regional_hostnames/{hostname}
ModelsExpand Collapse
class RegionalHostnameListResponse: …
created_on: datetime

When the regional hostname was created

formatdate-time
hostname: str

DNS hostname to be regionalized, must be a subdomain of the zone. Wildcards are supported for one level, e.g *.example.com

region_key: str

Identifying key for the region

routing: Optional[str]

Configure which routing method to use for the regional hostname

class RegionalHostnameGetResponse: …
created_on: datetime

When the regional hostname was created

formatdate-time
hostname: str

DNS hostname to be regionalized, must be a subdomain of the zone. Wildcards are supported for one level, e.g *.example.com

region_key: str

Identifying key for the region

routing: Optional[str]

Configure which routing method to use for the regional hostname

class RegionalHostnameCreateResponse: …
created_on: datetime

When the regional hostname was created

formatdate-time
hostname: str

DNS hostname to be regionalized, must be a subdomain of the zone. Wildcards are supported for one level, e.g *.example.com

region_key: str

Identifying key for the region

routing: Optional[str]

Configure which routing method to use for the regional hostname

class RegionalHostnameEditResponse: …
created_on: datetime

When the regional hostname was created

formatdate-time
hostname: str

DNS hostname to be regionalized, must be a subdomain of the zone. Wildcards are supported for one level, e.g *.example.com

region_key: str

Identifying key for the region

routing: Optional[str]

Configure which routing method to use for the regional hostname

class RegionalHostnameDeleteResponse: …
errors: List[Error]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[ErrorSource]
pointer: Optional[str]
messages: List[Message]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[MessageSource]
pointer: Optional[str]
success: Literal[true]

Whether the API call was successful.

Regional HostnamesRegions

List Regions
addressing.regional_hostnames.regions.list(RegionListParams**kwargs) -> SyncSinglePage[RegionListResponse]
GET/accounts/{account_id}/addressing/regional_hostnames/regions
ModelsExpand Collapse
class RegionListResponse: …
key: Optional[str]

Identifying key for the region

label: Optional[str]

Human-readable text label for the region