Logo
Akamai APIs API Documentation

Create a new edge hostname

POST https://{{host}}/papi/v1/edgehostnames?contractId={{contractId}}&groupId={{groupId}}

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.

 

Body PARAM

Key Datatype Required Description 
contractId
string (Required) Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix.
groupId
string (Required) Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix.
options
string (Optional) Currently the only supported option is `mapDetails` that enables extra mapping-related information. See [Site Shield API](https://techdocs.akamai.com/site-shield/reference/api) for more information.
accountSwitchKey
string (Optional) For customers who manage more than one account, this [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).



HEADERS

Key Datatype Required Description 
PAPI-Use-Prefixes
string
Curl
curl -X POST 'https://host/papi/v1/edgehostnames?contractId=&groupId=?contractId=&groupId=&options=&accountSwitchKey=' -H 'PAPI-Use-Prefixes: PAPI-Use-Prefixes' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"domainPrefix":"www.example.com","domainSuffix":"edgesuite.net","ipVersionBehavior":"IPV4","productId":"prd_Dynamic_Site_Del","secureNetwork":"STANDARD_TLS","useCases":[{"option":"BACKGROUND","type":"GLOBAL","useCase":"Download_Mode"}]}'

ENDPOINTS