List edge hostnames

GET https://{{host}}/hapi/v1/edge-hostnames

Lists all edge hostnames available for the logged-in account and context, optionally filtering results along several dimensions.

Request Params

KeyDatatypeRequiredDescription
chinaCdnEnabledstring(Optional) Filter by chinaCdnEnabled status.
commentsstring(Optional) Filter by comments value.
customTargetstring(Optional) Filter by customTarget value.
dnsZonestring(Optional) Filter by dnsZone value.
isEdgeIPBindingEnabledstring(Optional) Filter by isEdgeIPBindingEnabled status.
mapstring(Optional) Filter by map value.
mapAliasstring(Optional) Filter by mapAlias value.
recordNameSubstringstring(Optional) Filter by domain prefix substring.
securityTypestring(Optional) Enum Filter by securityType value, either STANDARD-TLS or ENHANCED-TLS.
slotNumberstring(Optional) Filter by slotNumber value.
ttlstring(Optional) Filter by ttl setting, in seconds.
includeMappingBehaviorsstring(Optional) Whether to include edge hostnames' mapping behaviors in the response, false by default.
accountSwitchKeystring(Optional) For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"edgeHostnames":[{"comments":"Created for example.com","dnsZone":"edgekey.net","edgeHostnameId":1,"ipVersionBehavior":"IPV6_IPV4_DUALSTACK","map":"e;dscb.akamaiedge.net","productId":"DSD","recordName":"www.example.com","securityType":"ENHANCED-TLS","slotNumber":11838,"ttl":21600,"useDefaultMap":true,"useDefaultTtl":true},{"comments":"Created for site","dnsZone":"edgesuite.net","edgeHostnameId":2,"ipVersionBehavior":"IPV4","map":"a;g.akamai.net","productId":"DSA","recordName":"www.examples.com","securityType":"STANDARD-TLS","serialNumber":140,"ttl":21600,"useDefaultMap":true,"useDefaultTtl":true},{"chinaCdn":{"isChinaCdn":true},"comments":"Created for China CDN","customTarget":"www.example-china.com.edgesuite.net.globalredir.akadns.net","dnsZone":"edgesuite.net","edgeHostnameId":3,"ipVersionBehavior":"IPV4","map":"a;g.akamai.net","mappingBehaviors":[{"options":[{"optionName":"optIn","optionValue":["India"]}],"behaviorName":"deliveryPolicy"}],"productId":"DSA","recordName":"www.example-china.com","securityType":"STANDARD-TLS","serialNumber":2322,"ttl":1800,"useDefaultMap":true,"useDefaultTtl":true},{"comments":"Created for EIP","customTarget":"www.example-eip.com.eip.akadns.net","dnsZone":"edgekey.net","edgeHostnameId":4,"ipVersionBehavior":"IPV4","isEdgeIPBindingEnabled":true,"productId":"DSA","recordName":"www.example-eip.com","securityType":"ENHANCED-TLS","slotNumber":2322,"ttl":21600,"useCases":[{"option":"VOD","type":"GLOBAL","useCase":"Segmented_Media_Mode"}],"useDefaultMap":true,"useDefaultTtl":true}]}