---
title: Regional Hostnames
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/typescript)

[Addressing](https://developers.cloudflare.com/api/typescript/resources/addressing)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Regional Hostnames

##### [List Regional Hostnames](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/regional_hostnames/methods/list)

client.addressing.regionalHostnames.list(RegionalHostnameListParams {zone\_id } params, RequestOptionsoptions?): SinglePage< [RegionalHostnameListResponse](<https://developers.cloudflare.com/api/typescript/resources/addressing#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_list_response%20%3E%20(schema)>) {created\_on, hostname, region\_key, routing } >

GET/zones/{zone\_id}/addressing/regional\_hostnames

##### [Fetch Regional Hostname](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/regional_hostnames/methods/get)

client.addressing.regionalHostnames.get(stringhostname, RegionalHostnameGetParams {zone\_id } params, RequestOptionsoptions?): [RegionalHostnameGetResponse](<https://developers.cloudflare.com/api/typescript/resources/addressing#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_get_response%20%3E%20(schema)>) {created\_on, hostname, region\_key, routing }

GET/zones/{zone\_id}/addressing/regional\_hostnames/{hostname}

##### [Create Regional Hostname](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/regional_hostnames/methods/create)

client.addressing.regionalHostnames.create(RegionalHostnameCreateParams {zone\_id, hostname, region\_key, routing } params, RequestOptionsoptions?): [RegionalHostnameCreateResponse](<https://developers.cloudflare.com/api/typescript/resources/addressing#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_create_response%20%3E%20(schema)>) {created\_on, hostname, region\_key, routing }

POST/zones/{zone\_id}/addressing/regional\_hostnames

##### [Update Regional Hostname](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/regional_hostnames/methods/edit)

client.addressing.regionalHostnames.edit(stringhostname, RegionalHostnameEditParams {zone\_id, region\_key } params, RequestOptionsoptions?): [RegionalHostnameEditResponse](<https://developers.cloudflare.com/api/typescript/resources/addressing#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_edit_response%20%3E%20(schema)>) {created\_on, hostname, region\_key, routing }

PATCH/zones/{zone\_id}/addressing/regional\_hostnames/{hostname}

##### [Delete Regional Hostname](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/regional_hostnames/methods/delete)

client.addressing.regionalHostnames.delete(stringhostname, RegionalHostnameDeleteParams {zone\_id } params, RequestOptionsoptions?): [RegionalHostnameDeleteResponse](<https://developers.cloudflare.com/api/typescript/resources/addressing#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_delete_response%20%3E%20(schema)>) {errors, messages, success }

DELETE/zones/{zone\_id}/addressing/regional\_hostnames/{hostname}

##### ModelsExpand Collapse

<details>

<summary>

RegionalHostnameListResponse {created\_on, hostname, region\_key, routing }

</summary>

created\_on: string

When the regional hostname was created

formatdate-time

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_list_response%20%3E%20(schema)%20%3E%20(property)%20created_on">Link to this property</a>

hostname: string

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

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_list_response%20%3E%20(schema)%20%3E%20(property)%20hostname">Link to this property</a>

region\_key: string

Identifying key for the region

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_list_response%20%3E%20(schema)%20%3E%20(property)%20region_key">Link to this property</a>

routing: string

Configure which routing method to use for the regional hostname

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_list_response%20%3E%20(schema)%20%3E%20(property)%20routing">Link to this property</a>

</details>

[Link to this property](<#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_list_response%20%3E%20(schema)>)

<details>

<summary>

RegionalHostnameGetResponse {created\_on, hostname, region\_key, routing }

</summary>

created\_on: string

When the regional hostname was created

formatdate-time

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_get_response%20%3E%20(schema)%20%3E%20(property)%20created_on">Link to this property</a>

hostname: string

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

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_get_response%20%3E%20(schema)%20%3E%20(property)%20hostname">Link to this property</a>

region\_key: string

Identifying key for the region

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_get_response%20%3E%20(schema)%20%3E%20(property)%20region_key">Link to this property</a>

routing: string

Configure which routing method to use for the regional hostname

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_get_response%20%3E%20(schema)%20%3E%20(property)%20routing">Link to this property</a>

</details>

[Link to this property](<#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_get_response%20%3E%20(schema)>)

<details>

<summary>

RegionalHostnameCreateResponse {created\_on, hostname, region\_key, routing }

</summary>

created\_on: string

When the regional hostname was created

formatdate-time

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_create_response%20%3E%20(schema)%20%3E%20(property)%20created_on">Link to this property</a>

hostname: string

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

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_create_response%20%3E%20(schema)%20%3E%20(property)%20hostname">Link to this property</a>

region\_key: string

Identifying key for the region

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_create_response%20%3E%20(schema)%20%3E%20(property)%20region_key">Link to this property</a>

routing: string

Configure which routing method to use for the regional hostname

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_create_response%20%3E%20(schema)%20%3E%20(property)%20routing">Link to this property</a>

</details>

[Link to this property](<#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_create_response%20%3E%20(schema)>)

<details>

<summary>

RegionalHostnameEditResponse {created\_on, hostname, region\_key, routing }

</summary>

created\_on: string

When the regional hostname was created

formatdate-time

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_edit_response%20%3E%20(schema)%20%3E%20(property)%20created_on">Link to this property</a>

hostname: string

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

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_edit_response%20%3E%20(schema)%20%3E%20(property)%20hostname">Link to this property</a>

region\_key: string

Identifying key for the region

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_edit_response%20%3E%20(schema)%20%3E%20(property)%20region_key">Link to this property</a>

routing: string

Configure which routing method to use for the regional hostname

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_edit_response%20%3E%20(schema)%20%3E%20(property)%20routing">Link to this property</a>

</details>

[Link to this property](<#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_edit_response%20%3E%20(schema)>)

<details>

<summary>

RegionalHostnameDeleteResponse {errors, messages, success }

</summary>

<details>

<summary>

errors: Array&lt;Error&gt;

</summary>

code: number

minimum1000

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_delete_response%20%3E%20(schema)%20%3E%20(property)%20errors%20%3E%20(items)%20%3E%20(property)%20code">Link to this property</a>

message: string

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_delete_response%20%3E%20(schema)%20%3E%20(property)%20errors%20%3E%20(items)%20%3E%20(property)%20message">Link to this property</a>

documentation\_url?: string

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_delete_response%20%3E%20(schema)%20%3E%20(property)%20errors%20%3E%20(items)%20%3E%20(property)%20documentation_url">Link to this property</a>

<details>

<summary>

source?: Source {pointer }

</summary>

pointer?: string

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_delete_response%20%3E%20(schema)%20%3E%20(property)%20errors%20%3E%20(items)%20%3E%20(property)%20source%20%3E%20(property)%20pointer">Link to this property</a>

</details>

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_delete_response%20%3E%20(schema)%20%3E%20(property)%20errors%20%3E%20(items)%20%3E%20(property)%20source">Link to this property</a>

</details>

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_delete_response%20%3E%20(schema)%20%3E%20(property)%20errors">Link to this property</a>

<details>

<summary>

messages: Array&lt;Message&gt;

</summary>

code: number

minimum1000

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_delete_response%20%3E%20(schema)%20%3E%20(property)%20messages%20%3E%20(items)%20%3E%20(property)%20code">Link to this property</a>

message: string

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_delete_response%20%3E%20(schema)%20%3E%20(property)%20messages%20%3E%20(items)%20%3E%20(property)%20message">Link to this property</a>

documentation\_url?: string

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_delete_response%20%3E%20(schema)%20%3E%20(property)%20messages%20%3E%20(items)%20%3E%20(property)%20documentation_url">Link to this property</a>

<details>

<summary>

source?: Source {pointer }

</summary>

pointer?: string

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_delete_response%20%3E%20(schema)%20%3E%20(property)%20messages%20%3E%20(items)%20%3E%20(property)%20source%20%3E%20(property)%20pointer">Link to this property</a>

</details>

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_delete_response%20%3E%20(schema)%20%3E%20(property)%20messages%20%3E%20(items)%20%3E%20(property)%20source">Link to this property</a>

</details>

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_delete_response%20%3E%20(schema)%20%3E%20(property)%20messages">Link to this property</a>

success: true

Whether the API call was successful.

<a href="#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_delete_response%20%3E%20(schema)%20%3E%20(property)%20success">Link to this property</a>

</details>

[Link to this property](<#(resource)%20addressing.regional_hostnames%20%3E%20(model)%20regional_hostname_delete_response%20%3E%20(schema)>)

#### Regional HostnamesRegions

##### [List Regions](https://developers.cloudflare.com/api/typescript/resources/addressing/subresources/regional_hostnames/subresources/regions/methods/list)

client.addressing.regionalHostnames.regions.list(RegionListParams {account\_id } params, RequestOptionsoptions?): SinglePage< [RegionListResponse](<https://developers.cloudflare.com/api/typescript/resources/addressing#(resource)%20addressing.regional_hostnames.regions%20%3E%20(model)%20region_list_response%20%3E%20(schema)>) {key, label } >

GET/accounts/{account\_id}/addressing/regional\_hostnames/regions

##### ModelsExpand Collapse

<details>

<summary>

RegionListResponse {key, label }

</summary>

key?: string

Identifying key for the region

<a href="#(resource)%20addressing.regional_hostnames.regions%20%3E%20(model)%20region_list_response%20%3E%20(schema)%20%3E%20(property)%20key">Link to this property</a>

label?: string

Human-readable text label for the region

<a href="#(resource)%20addressing.regional_hostnames.regions%20%3E%20(model)%20region_list_response%20%3E%20(schema)%20%3E%20(property)%20label">Link to this property</a>

</details>

[Link to this property](<#(resource)%20addressing.regional_hostnames.regions%20%3E%20(model)%20region_list_response%20%3E%20(schema)>)