Skip to content
Start here

Regional Hostnames

List Regional Hostnames
GET/zones/{zone_id}/addressing/regional_hostnames
Fetch Regional Hostname
GET/zones/{zone_id}/addressing/regional_hostnames/{hostname}
Create Regional Hostname
POST/zones/{zone_id}/addressing/regional_hostnames
Update Regional Hostname
PATCH/zones/{zone_id}/addressing/regional_hostnames/{hostname}
Delete Regional Hostname
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: optional 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: optional 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: optional 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: optional string

Configure which routing method to use for the regional hostname

RegionalHostnameDeleteResponse { errors, messages, success }
errors: array of { code, message, documentation_url, source }
code: number
minimum1000
message: string
documentation_url: optional string
source: optional { pointer }
pointer: optional string
messages: array of { code, message, documentation_url, source }
code: number
minimum1000
message: string
documentation_url: optional string
source: optional { pointer }
pointer: optional string
success: true

Whether the API call was successful.

Regional HostnamesRegions

List Regions
GET/accounts/{account_id}/addressing/regional_hostnames/regions
ModelsExpand Collapse
RegionListResponse { key, label }
key: optional string

Identifying key for the region

label: optional string

Human-readable text label for the region