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.

Request Params

KeyDatatypeRequiredDescription
contractIdstring(Required) Unique identifier for the contract. See ID prefixes for details on omitting the value's ctr_ prefix.
groupIdstring(Required) Unique identifier for the group. See ID prefixes for details on omitting the value's grp_ prefix.
optionsstring(Optional) Currently the only supported option is mapDetails that enables extra mapping-related information. See Site Shield API for more information.
accountSwitchKeystring(Optional) 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.

Request Body

{"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"}]}

HEADERS

KeyDatatypeRequiredDescription
PAPI-Use-Prefixesstring(Required) Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs.
Content-Typestring
Acceptstring

RESPONSES

status: Created

{"edgeHostnameLink":"/papi/v0/edgehostnames/ehn_1332?contractId=ctr_C-0N7RAC7\u0026grp_15225"}