API
Start typing to search…

List edge hostnames

get https://{hostname}/papi/v1/edgehostnames

This lists all edge hostnames available under a contract. To assign any of these hostnames to a property, run Update a property's hostnames. Use the Edge Hostname API (HAPI) to modify edge hostnames, or delete any that aren't currently assigned to an active property configuration.

Recipes
List edge hostnames
Open Recipe
Query Params
string
required

Unique identifier for the contract. See ID prefixes for details on omitting the value's ctr_ prefix.

string
required

Unique identifier for the group. See ID prefixes for details on omitting the value's grp_ prefix.

string

Currently the only supported option is mapDetails that enables extra mapping-related information. See Site Shield API for more information.

string

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
string
required

Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs.

Responses

Response body
object
string

Identifies the prevailing account under which you requested the data. See ID prefixes for details on how to omit the ID's act_ prefix.

string

Identifies the prevailing contract under which you requested the data. See ID prefixes for details on how to omit the ID's ctr_ prefix.

object

The set of requested edge hostnames, available within an items array.

array of objects

Specifies a set of available hostnames a property version may use. To POST a new edge hostname, specify a single object with productId, domainPrefix, and domainSuffix members, and optional ipVersionBehavior and secure members. Set secureNetwork for a Standard TLS, Enhanced TLS, or a shared certificate edge hostname. Relevant response objects appear within the outer envelope's edgehostnames.items array.

items
object
object

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.

string
required

The origin domain portion of the edge hostname. An edge hostname consists of a customer-specific namePrefix such as www.example.com and an Akamai-specific domainSuffix such as edgesuite.net. The edge hostname's final DNS CNAME combines the two, for example, www.example.com.edgesuite.net.

string
required

The Akamai-specific portion of the edge hostname, for example, edgesuite.net.

string
required

The full edge domain name formed from the domainPrefix and domainSuffix.

string
required

The edge hostname's unique identifier, which can be assigned to a property. See ID prefixes for details on how to omit the ID's ehn_ prefix.

string
required
Defaults to IPV4

Which version of the IP protocol to use: IPV4 for version 4 only, or IPV6_COMPLIANCE for both 4 and 6. The default value for requests is IPV4.

IPV4 IPV6_COMPLIANCE

string

The product you created the edge hostname for. See ID prefixes for details on how to omit the ID's prd_ prefix.

boolean
required
Defaults to false

Whether to use the edge hostname with SSL. Defaults to false for POST requests. Enabling this option for new edge hostnames isn't supported.

string

Appears as PENDING for any newly defined hostname whose DNS mapping hasn't yet been distributed across the entire Akamai network. CREATED indicates the DNS mapping distribution has completed. If status is omitted, it indicates the edge hostname is active. Note that an edge hostname's status is unrelated to a property activation's deployment status.

PENDING CREATED

array of objects
length ≥ 1

Available use cases for edge hostnames assigned to the product. The preset use case scenarios provided by Akamai help optimally map different types of traffic across the Akamai edge network.

useCases
object
string
required

Specifies one of the available options available in the response object.

string
required

Identifies the type of network over which traffic deploys. The only value currently available is GLOBAL. Use this to specify the same member name available in the use case response object.

GLOBAL

string
required

Identifies each use case.

string

Identifies the prevailing group under which you requested the data. See ID prefixes for details on how to omit the ID's grp_ prefix.

Headers
object
string

Maximum number of edge hostnames per contract.

string

Remaining number of edge hostnames per contract. See Rate and resource limiting for details.

integer

Maximum sustainable number of request allowed each minute per account. This rate limit protects PAPI resources from being exhausted by single users. Once you exceed the limit, you receive the 429 error. If you call PAPI using multiple API clients within the same account, the rate limit applies globally to all API clients.

This API also provides a burst limit that specifies how many requests you can make in excess of the imposed rate limit. The one-time burst limit is 1000 requests. Once you consume all available resources, the burst capacity increases steadily by 100 requests every minute, until it reaches its initial maximum limit of 1000.

integer

Remianing number of requests allowed each minute per account. See Rate and resource limiting for details.

Updated over 1 year ago

Did this page help you?
Language
Authentication
Remember to add your authentication credentials to run this code.
URL

Updated over 1 year ago

Did this page help you?