--- updatedAt: 2026-03-01T18:31:02.000Z agentTools: siteIndex: https://techdocs.akamai.com/llms.txt projectIndex: https://techdocs.akamai.com/edge-hostnames/llms.txt --- # List edge hostnames Lists all edge hostnames available for the logged-in account and context, optionally filtering results along several dimensions. # OpenAPI definition ```json { "externalDocs": { "description": "See documentation for Akamai's Edge Hostnames API", "url": "https://techdocs.akamai.com/edge-hostnames/reference" }, "info": { "title": "Edge Hostnames", "version": "v1" }, "openapi": "3.0.0", "paths": { "/edge-hostnames": { "get": { "description": "Lists all edge hostnames available for the logged-in account and context, optionally filtering results along several dimensions.\n", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Hostnames API", "url": "https://techdocs.akamai.com/edge-hostnames/reference/get-edgehostnames" }, "operationId": "get-edgehostnames", "parameters": [ { "description": "Filter by `chinaCdnEnabled` status.\n", "in": "query", "name": "chinaCdnEnabled", "required": false, "schema": { "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/chinaCdnEnabled-query.yaml" } }, { "description": "Filter by `comments` value.\n", "in": "query", "name": "comments", "required": false, "schema": { "example": "Created for site", "type": "string" }, "x-akamai": { "file-path": "parameters/comments-query.yaml" } }, { "description": "Filter by `customTarget` value.\n", "in": "query", "name": "customTarget", "required": false, "schema": { "example": "www.example-eip.com.eip.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/customTarget-query.yaml" } }, { "description": "Filter by `dnsZone` value.\n", "in": "query", "name": "dnsZone", "required": false, "schema": { "example": "edgesuite.net", "type": "string" }, "x-akamai": { "file-path": "parameters/dnsZone-query.yaml" } }, { "description": "Filter by `isEdgeIPBindingEnabled` status.\n", "in": "query", "name": "isEdgeIPBindingEnabled", "required": false, "schema": { "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/isEdgeIPBindingEnabled-query.yaml" } }, { "description": "Filter by `map` value.\n", "in": "query", "name": "map", "required": false, "schema": { "example": "a;g.akamai.net", "type": "string" }, "x-akamai": { "file-path": "parameters/map-query.yaml" } }, { "description": "Filter by `mapAlias` value.\n", "in": "query", "name": "mapAlias", "required": false, "schema": { "example": "a;g4.akamai.net", "type": "string" }, "x-akamai": { "file-path": "parameters/mapAlias-query.yaml" } }, { "description": "Filter by domain prefix substring.\n", "in": "query", "name": "recordNameSubstring", "required": false, "schema": { "example": "edgesuite.net", "type": "string" }, "x-akamai": { "file-path": "parameters/recordNameSubstring-query.yaml" } }, { "description": "__Enum__. Filter by `securityType` value, either `STANDARD-TLS` or `ENHANCED-TLS`.\n", "in": "query", "name": "securityType", "required": false, "schema": { "enum": [ "STANDARD-TLS", "ENHANCED-TLS" ], "example": "STANDARD-TLS", "type": "string" }, "x-akamai": { "file-path": "parameters/securityType-query.yaml" } }, { "description": "Filter by `slotNumber` value.\n", "in": "query", "name": "slotNumber", "required": false, "schema": { "example": 140, "type": "integer" }, "x-akamai": { "file-path": "parameters/slotNumber-query.yaml" } }, { "description": "Filter by `ttl` setting, in seconds.\n", "in": "query", "name": "ttl", "required": false, "schema": { "example": 21600, "type": "integer" }, "x-akamai": { "file-path": "parameters/ttl-query.yaml" } }, { "description": "Whether to include the delivery policy in the response. The default is `false`.\n", "in": "query", "name": "includeDeliveryPolicy", "required": false, "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/includeDeliveryPolicy-query.yaml" } }, { "description": "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).\n", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "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", "deliveryPolicy": { "policyAttributes": [ { "attributeType": "GEO", "code": "US", "name": "USA" } ], "policyType": "GEO_OPT_IN" }, "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": { "gtmDomain": "globalredir.akadns.net", "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", "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 } ] }, "schema": { "additionalProperties": false, "description": "Available edge hostnames.\n", "properties": { "edgeHostnames": { "description": "Available edge hostnames.\n", "items": { "additionalProperties": false, "description": "Specifies a set of available hostnames to which a property version may be applied.\n", "properties": { "chinaCdn": { "additionalProperties": false, "description": "Indicates whether the edge hostname can serve traffic in China. See [China Application and API Traffic Solutions](https://techdocs.akamai.com/china/docs/welcome) to learn more about content delivery in mainland China.\n", "properties": { "chinaPartner": { "description": "The name of the China partner.\n", "type": "string" }, "customChinaCdnMap": { "description": "Shows the custom China CDN map you are using, if applicable. If a `chinaPartner` is specified, this value is required and is the hostname configured with the China partner.\n", "type": "string" }, "gtmDomain": { "description": "The Global Traffic Management (GTM) domain that serves traffic in China.\n", "type": "string" }, "isChinaCdn": { "description": "Indicates whether the edge hostname can serve traffic in China.\n", "type": "boolean" } }, "required": [ "isChinaCdn" ], "type": "object", "x-akamai": { "file-path": "schemas/edge-hostname-china-cdn.yaml" } }, "comments": { "description": "The comments provided upon the creation of the edge hostname (via Property Manager or Property Manager API).\n", "type": "string" }, "customTarget": { "description": "The custom targets of the edge hostname. A custom target is a user-specified target for the edge hostname.\n", "type": "string" }, "deliveryPolicy": { "additionalProperties": false, "description": "Specifies the delivery policy that controls the edge traffic for your application. Akamai Professional Services can set it on your behalf. For more information, see [Delivery Policy Manager](https://techdocs.akamai.com/delivery-policy-mgr/docs/welcome).\n", "properties": { "policyAttributes": { "description": "Specifies the delivery policy details.\n", "items": { "additionalProperties": false, "description": "Specifies the delivery policy details.\n", "properties": { "attributeType": { "description": "The type of policy attribute. For edge hostnames, the only supported value is `GEO`, which keeps your edge traffic within a specified geographical region.\n", "enum": [ "GEO" ], "type": "string" }, "code": { "description": "The code of the geographical region you want to keep your edge traffic within. The currently available regions are `EU_CH_GB`, `IN` and `US`.\n", "enum": [ "EU_CH_GB", "IN", "US" ], "type": "string" }, "name": { "description": "The name of the policy attribute. This specifies geographical regions you want to keep your edge traffic within. The currently available regions are `European Union, Switzerland and Great Britain`, `India` and `USA`.\n", "enum": [ "European Union, Switzerland and Great Britain", "India", "USA" ], "type": "string" } }, "required": [ "code" ], "type": "object", "x-akamai": { "file-path": "schemas/edge-hostname-delivery-policy-attribute.yaml" } }, "minItems": 1, "type": "array" }, "policyType": { "description": "Specifies the type of delivery policy assigned to your edge hostname. Currently, the only supported value is `GEO_OPT_IN`, which keeps your edge traffic within a specified geographical region.\n", "enum": [ "GEO_OPT_IN" ], "type": "string" } }, "required": [ "policyType", "policyAttributes" ], "type": "object", "x-akamai": { "file-path": "schemas/edge-hostname-delivery-policy.yaml" } }, "dnsSerial": { "description": "The serial number for the edge hostname.\n", "type": "string" }, "dnsZone": { "description": "The Akamai-specific portion of the edge hostname, for example the `edgesuite.net` portion of `www.example.com.edgesuite.net`.\n", "type": "string" }, "edgeHostnameId": { "description": "The edge hostname's unique identifier, which you can assign to a property.\n", "type": "integer" }, "ipVersionBehavior": { "description": "Which version of the IP protocol to use: `IPV4` for version 4 only, or `IPV6_IPV4_DUALSTACK` for both 4 and 6.\n", "enum": [ "IPV4", "IPV6_IPV4_DUALSTACK" ], "type": "string" }, "isEdgeIPBindingEnabled": { "description": "Indicates whether Edge IP Binding is enabled. Edge IP Binding helps deliver traffic from fixed IP addresses in a scalable manner.\n", "type": "boolean" }, "map": { "description": "The correlation between your edge hostname and the IP address that the hostname resolves to.\n", "type": "string" }, "mapAlias": { "description": "An alternate name for a map. Can be used to establish a different time to live (TTL) for the same map, for example.\n", "type": "string" }, "productId": { "description": "A unique identifier for the product associated with the edge hostname.\n", "type": "string" }, "recordName": { "description": "The origin domain portion of the edge hostname, for example the `www.example.com` portion of `www.example.com.edgesuite.net`.\n", "type": "string" }, "securityType": { "description": "Indicates whether `STANDARD-TLS` or `ENHANCED-TLS` security applies to this edge hostname.\n", "enum": [ "STANDARD-TLS", "ENHANCED-TLS" ], "type": "string" }, "serialNumber": { "description": "The serial number for the standard-tls hostname.\n", "type": "integer" }, "slotNumber": { "description": "Sets the slot number for the enhanced-tls hostnames. Only applies when `securityType` is set to `ENHANCED-TLS`.\n", "type": "integer" }, "ttl": { "description": "The time to live, or number of seconds to keep an edge hostname assigned to a map or target. This determines how long it takes for changes to the edge hostname to take effect.\n", "type": "integer" }, "useCases": { "description": "Specifies a set of Akamai-provided preset use case scenarios to help optimize different types of traffic. You can assign use cases when creating a new edge hostname in the Property Manager API (PAPI). For details, see [Assign a use case to an edge hostname](https://techdocs.akamai.com/property-mgr/reference/post-edgehostnames).\n", "items": { "additionalProperties": false, "description": "Specifies a set of Akamai-provided preset use case scenarios to help optimize different types of traffic. You can assign use cases when creating a new edge hostname in the Property Manager API (PAPI). For details, see [Assign a use case to an edge hostname](https://developer.akamai.com/api/core_features/property_manager/v1.html#assignausecase).\n", "properties": { "option": { "description": "Specifies one of the use case's available options that help specify the type of traffic.\n", "type": "string" }, "type": { "description": "Identifies the Akamai network over which traffic deploys. The only value currently available is the `GLOBAL` network.\n", "enum": [ "GLOBAL" ], "type": "string" }, "useCase": { "description": "A unique identifier for each use case.\n", "type": "string" } }, "required": [ "useCase", "option" ], "type": "object", "x-akamai": { "file-path": "schemas/edge-hostname-usecase.yaml" } }, "maxItems": 2, "minItems": 1, "type": "array" }, "useDefaultMap": { "description": "Indicates if the product's default map is being used or not.\n", "type": "boolean" }, "useDefaultTtl": { "description": "Indicates if the product's default TTL (time to live) settings are being used for the edge hostname or if a custom one has been set.\n", "type": "boolean" } }, "required": [ "recordName", "dnsZone", "securityType", "productId", "useDefaultTtl", "useDefaultMap" ], "type": "object", "x-akamai": { "file-path": "schemas/edge-hostname.yaml" } }, "type": "array" } }, "required": [ "edgeHostnames" ], "type": "object", "x-akamai": { "file-path": "schemas/get-edge-hostnames-response.yaml" } } } }, "description": "List of edge hostnames.\n" } }, "summary": "List edge hostnames", "tags": [ "Edge hostnames" ] } } }, "servers": [ { "url": "https://{hostname}/hapi/v1" } ], "tags": [ { "description": "Manage your edge hostnames.", "name": "Edge hostnames" } ], "x-akamai": { "auth-type": "EDGE_GRID", "file-path": "hapi-openV1.yaml" }, "x-readme": { "samples-languages": [ "curl", "python", "node" ], "explorer-enabled": true, "proxy-enabled": true } } ``` # Sibling pages * [Get an edge hostname by DNS zone and record name](https://techdocs.akamai.com/edge-hostnames/reference/get-edgehostname.md) * [Patch an edge hostname](https://techdocs.akamai.com/edge-hostnames/reference/patch-edgehostnames.md) * [Delete an edge hostname](https://techdocs.akamai.com/edge-hostnames/reference/delete-edgehostname.md) * [Get an edge hostname](https://techdocs.akamai.com/edge-hostnames/reference/get-edgehostnameid.md)