Akamai APIs API Documentation
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.
Body
PARAM
| Key | Datatype | Required | Description |
chinaCdnEnabled
|
string | (Optional) Filter by `chinaCdnEnabled` status. | |
comments
|
string | (Optional) Filter by `comments` value. | |
customTarget
|
string | (Optional) Filter by `customTarget` value. | |
dnsZone
|
string | (Optional) Filter by `dnsZone` value. | |
isEdgeIPBindingEnabled
|
string | (Optional) Filter by `isEdgeIPBindingEnabled` status. | |
map
|
string | (Optional) Filter by `map` value. | |
mapAlias
|
string | (Optional) Filter by `mapAlias` value. | |
recordNameSubstring
|
string | (Optional) Filter by domain prefix substring. | |
securityType
|
string | (Optional) __Enum__ Filter by `securityType` value, either `STANDARD-TLS` or `ENHANCED-TLS`. | |
slotNumber
|
string | (Optional) Filter by `slotNumber` value. | |
ttl
|
string | (Optional) Filter by `ttl` setting, in seconds. | |
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
| {
"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
}
]
} |
Curl
curl -X GET 'https://undefined/hapi/v1/edge-hostnames?chinaCdnEnabled=&comments=&customTarget=&dnsZone=&isEdgeIPBindingEnabled=&map=&mapAlias=&recordNameSubstring=&securityType=&slotNumber=&ttl=&includeMappingBehaviors=&accountSwitchKey=' -H 'Accept: application/json'
ENDPOINTS