Create a new edge hostname

Note: You can skip this operation if you're using a Default Domain Validation (DV) certificate, which automatically creates an edge hostname upon activation.

This POST operation creates a new edge hostname. As detailed in the sections below, you can use three approaches to secure new edge hostnames: Standard TLS, Enhanced TLS, or a Shared Certificate. You can assign a use case mapping profile to optimize the hostname to serve specific types of traffic. Once the edge hostname is active, you can Update a property's hostnames to assign it to a hostname on a property. After you activate a property, modifying your DNS to map the property hostname to the edge hostname ultimately enables traffic on the property. For details, see Enable traffic for a new hostname. Use the Edge Hostname API (HAPI) to modify edge hostnames, or delete any that aren't currently assigned to an active property configuration.

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.

Body Params
integer
≥ 1

When creating an Enhanced TLS edge hostname, this sets the certificate enrollment ID. Specify this on POST, with secureNetwork set to ENHANCED_TLS. To obtain a value programmatically, run the Certificate Provisioning System API's List enrollments operation. Choose the appropriate enrollment, strip the leading path expression from its location member, and use that value as the certEnrollmentId.

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. The suffix depends on the value you specify in the secureNetwork field.

string
enum
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.

Allowed:
string
required

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

boolean
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
enum

On POST, specifies the type of security for the new edge hostname. For STANDARD_TLS, specify a domainSuffix of edgesuite.net. To create the STANDARD_TLS edge hostname with the akamaized.net suffix, use the Property Manager application in Control Center, as currently PAPI doesn't support this combination. For SHARED_CERT, specify a domainSuffix of akamaized.net. For ENHANCED_TLS, you need to specify a certEnrollmentId value along with a domainSuffix of edgekey.net.

Allowed:
integer
≥ 1

On POST, sets the slot number for secure ESSL properties.

useCases
array of objects
length between 0 and 2

Optionally when configuring a new edge hostname, this assigns a preset use case that characterizes the type of traffic served. Use cases optimize deployment over the Akamai edge network. To gather values to add to this object, run the List use cases operation.

useCases
Headers
string
enum
required

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

Allowed:
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json