Skip to content
Cloudflare API
Start here
API Reference
Addressing

Regional Hostnames

List Regional Hostnames
client.addressing.regionalHostnames.list(RegionalHostnameListParams { zone_id } params, RequestOptionsoptions?): SinglePage<RegionalHostnameListResponse { created_on, hostname, region_key, routing } >
GET/zones/{zone_id}/addressing/regional_hostnames
Fetch Regional Hostname
client.addressing.regionalHostnames.get(stringhostname, RegionalHostnameGetParams { zone_id } params, RequestOptionsoptions?): RegionalHostnameGetResponse { created_on, hostname, region_key, routing }
GET/zones/{zone_id}/addressing/regional_hostnames/{hostname}
Create Regional Hostname
client.addressing.regionalHostnames.create(RegionalHostnameCreateParams { zone_id, hostname, region_key, routing } params, RequestOptionsoptions?): RegionalHostnameCreateResponse { created_on, hostname, region_key, routing }
POST/zones/{zone_id}/addressing/regional_hostnames
Update Regional Hostname
client.addressing.regionalHostnames.edit(stringhostname, RegionalHostnameEditParams { zone_id, region_key } params, RequestOptionsoptions?): RegionalHostnameEditResponse { created_on, hostname, region_key, routing }
PATCH/zones/{zone_id}/addressing/regional_hostnames/{hostname}
Delete Regional Hostname
client.addressing.regionalHostnames.delete(stringhostname, RegionalHostnameDeleteParams { zone_id } params, RequestOptionsoptions?): RegionalHostnameDeleteResponse { errors, messages, success }
DELETE/zones/{zone_id}/addressing/regional_hostnames/{hostname}
ModelsExpand Collapse
RegionalHostnameListResponse { created_on, hostname, region_key, routing }
created_on: string

When the regional hostname was created

formatdate-time
hostname: string

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

region_key: string

Identifying key for the region

routing?: string

Configure which routing method to use for the regional hostname

RegionalHostnameGetResponse { created_on, hostname, region_key, routing }
created_on: string

When the regional hostname was created

formatdate-time
hostname: string

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

region_key: string

Identifying key for the region

routing?: string

Configure which routing method to use for the regional hostname

RegionalHostnameCreateResponse { created_on, hostname, region_key, routing }
created_on: string

When the regional hostname was created

formatdate-time
hostname: string

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

region_key: string

Identifying key for the region

routing?: string

Configure which routing method to use for the regional hostname

RegionalHostnameEditResponse { created_on, hostname, region_key, routing }
created_on: string

When the regional hostname was created

formatdate-time
hostname: string

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

region_key: string

Identifying key for the region

routing?: string

Configure which routing method to use for the regional hostname

RegionalHostnameDeleteResponse { errors, messages, success }
errors: Array<Error>
code: number
minimum1000
message: string
documentation_url?: string
source?: Source { pointer }
pointer?: string
messages: Array<Message>
code: number
minimum1000
message: string
documentation_url?: string
source?: Source { pointer }
pointer?: string
success: true

Whether the API call was successful.

Regional HostnamesRegions

List Regions
client.addressing.regionalHostnames.regions.list(RegionListParams { account_id } params, RequestOptionsoptions?): SinglePage<RegionListResponse { key, label } >
GET/accounts/{account_id}/addressing/regional_hostnames/regions
ModelsExpand Collapse
RegionListResponse { key, label }
key?: string

Identifying key for the region

label?: string

Human-readable text label for the region