--- updatedAt: 2026-03-01T18:30:59.000Z agentTools: siteIndex: https://techdocs.akamai.com/llms.txt projectIndex: https://techdocs.akamai.com/edge-hostnames/llms.txt --- # Get an edge hostname by DNS zone and record name 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. # 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": { "/dns-zones/{dnsZone}/edge-hostnames/{recordName}": { "get": { "description": "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.\n", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Hostnames API", "url": "https://techdocs.akamai.com/edge-hostnames/reference/get-edgehostname" }, "operationId": "get-edgehostname", "parameters": [ { "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": { "comments": "Created for example.com", "deliveryPolicy": { "policyAttributes": [ { "attributeType": "GEO", "code": "US", "name": "USA" } ], "policyType": "GEO_OPT_IN" }, "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, "useCases": [ { "option": "BACKGROUND", "type": "GLOBAL", "useCase": "Download_Mode" } ], "useDefaultMap": true, "useDefaultTtl": true }, "schema": { "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" } } } }, "description": "Specifies a set of available hostnames to which a property version may be applied.\n" }, "404": { "content": { "application/json": { "example": { "detail": "Could not find edge hostname with record name non-existent-test and DNS Zone edgesuite.net", "domainPrefix": "non-existent-test", "domainSuffix": "edgesuite.net", "errors": [], "instance": "/hapi/error-instances/61037ab7-0f4e-4dc0-8d0e-af408195071a", "method": "GET", "requestInstance": "http://control.cloud-sqa-shared.akamai.com/hapi/v1/dns-zones/edgesuite.net/edge-hostnames/non-existent-test/change-requests?contractId=1-3CV382&includeDeliveryPolicy=true&includeEdgeHostnames=true#34edcb5d", "requestTime": "2024-02-07T15:22:53.290766768Z", "status": 404, "title": "Invalid Record Name/DNS Zone", "type": "/hapi/problems/record-name-dns-zone-not-found" }, "schema": { "additionalProperties": true, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.\n", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.\n", "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each separately as a nested Problem Details object.\n", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "extensionFields": { "description": "This helps locate problems with specific request fields.\n", "items": { "additionalProperties": false, "properties": { "key": { "description": "The name of the request field.\n", "type": "string" }, "value": { "description": "The provided value that triggered the error.\n", "type": "string" } }, "type": "object" }, "type": "array" }, "instance": { "description": "Unique value generated with each API call.\n", "format": "uri", "type": "string" }, "status": { "description": "The HTTP status code under which this error falls.\n", "type": "number" }, "title": { "description": "A summary of each error case.\n", "type": "string" }, "type": { "description": "Identifies each error case.\n", "format": "uri", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "Resource deleted.\n" } }, "summary": "Get an edge hostname by DNS zone and record name", "tags": [ "Edge hostnames" ] }, "parameters": [ { "description": "Record name of the edge hostname.\n", "in": "path", "name": "recordName", "required": true, "schema": { "example": "www.example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/recordName-path.yaml" } }, { "description": "DNS zone of the edge hostname.\n", "in": "path", "name": "dnsZone", "required": true, "schema": { "example": "edgesuite.net", "type": "string" }, "x-akamai": { "file-path": "parameters/dnsZone-path.yaml" } } ] } }, "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 * [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) * [List edge hostnames](https://techdocs.akamai.com/edge-hostnames/reference/get-edgehostnames.md) * [Get an edge hostname](https://techdocs.akamai.com/edge-hostnames/reference/get-edgehostnameid.md)