Logo
Akamai APIs API Documentation

Get an edge hostname by DNS zone and record name

GET https://{{host}}/hapi/v1/dns-zones/:dnsZone/edge-hostnames/:recordName

Retrieve the full record for a single edge hostname as specified by its DNS zone and record name to view its details such product ID, IP version behavior, China CDN status, or Edge IP Binding status.

 

Body PARAM

Key Datatype Required Description 
includeMappingBehaviors
string (Optional) Whether to include edge hostnames' mapping behaviors in the response, `false` by default.
accountSwitchKey
string (Optional) For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).



HEADERS

Key Datatype Required Description 
Accept
string




RESPONSES

status OK

{ "comments": "Created for example.com", "dnsZone": "edgekey.net", "edgeHostnameId": 1, "ipVersionBehavior": "IPV6_IPV4_DUALSTACK", "isSecure": true, "map": "e;dscb.akamaiedge.net", "mappingBehaviors": [ { "options": [ { "optionName": "optIn", "optionValue": [ "United States" ] } ], "behaviorName": "deliveryPolicy" } ], "productId": "DSD", "recordName": "www.example.com", "slotNumber": 11838, "ttl": 21600, "useCases": [ { "option": "BACKGROUND", "type": "GLOBAL", "useCase": "Download_Mode" } ], "useDefaultMap": true, "useDefaultTtl": true }



Curl
curl -X GET 'https://undefined/hapi/v1/dns-zones/:dnsZone/edge-hostnames/:recordName?includeMappingBehaviors=&accountSwitchKey=' -H 'Accept: application/json'

ENDPOINTS