Create an edge hostname

This operation creates a new edge hostname. An edge hostname is a DNS-based CNAME target that maps end-user traffic for your service hostnames to the optimal edge server rather than your origin. If you set the pauseBeforeActivating query to true, the system pauses the creation process after validation. This lets you review or adjust settings while the edge hostname is in the STAGED state before it goes live.

Query Params
boolean
Defaults to false

Indicates whether the activation should pause after validation. This allows you to review validation results and activation summary while the activation is in the STAGED state. You can then resume the activation. When false, the activation proceeds immediately after a successful validation.

string
required

Filters results by a single group ID, corresponding to either defaultGroupId or additionalGroupId. The defaultGroupId specifies the primary owner like the core platform team with full administrative control over the workspace and its resources. An additionalGroupId specifies secondary teams with fine-grained access to specific components for cross-team collaboration without full infrastructure ownership. You configure groups in Identity and Access Management.

string
required

A single contract to filter results by, linking to a billing or licensing agreement.

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.

Body Params
string
required

An edge hostname is a DNS-based CNAME target that directs end-user traffic to the optimal edge server rather than your origin. It consists of a prefix, usually your service hostname, and an Akamai-specific suffix related to a security level for client-to-edge traffic. For Standard TLS, use the .edgesuite.net suffix. For Enhanced TLS, use the .edgekey.net suffix. The final DNS CNAME combines the two, for example www.example.com.edgesuite.net. While the prefix can be any unique string not reserved in the system, use your service hostname as best practice.

string
enum

HTTPS service binding configuration for the edge hostname.

Allowed:
string
enum
Defaults to IPV6_IPV4_DUALSTACK

Specifies the version of the IP protocol to use for the edge hostname: IPV4 for version 4 only, IPV6 for version 6 only, or IPV6_IPV4_DUALSTACK for both 4 and 6.

Allowed:
string
required

The product you created the edge hostname for.

Response

Language
URL
LoadingLoading…
Response
Choose an example:
application/json