List edge hostnames
GET https://{{host}}/papi/v1/edgehostnames?contractId={{contractId}}&groupId={{groupId}}
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.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
contractId | string | (Required) Unique identifier for the contract. See ID prefixes for details on omitting the value's ctr_ prefix. | |
groupId | string | (Required) Unique identifier for the group. See 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 for more information. | |
accountSwitchKey | string | (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. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
PAPI-Use-Prefixes | string | (Required) Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs. | |
Accept | string |
RESPONSES
status: OK
{"accountId":"act_A-CCT9012","contractId":"ctr_C-0N7RAC7","edgeHostnames":{"items":[{"domainPrefix":"example.com","domainSuffix":"edgekey.net","edgeHostnameDomain":"example.com.edgekey.net","edgeHostnameId":"ehn_895822","ipVersionBehavior":"IPV4","productId":"prd_Alta","secure":true,"status":"PENDING"},{"domainPrefix":"example.com","domainSuffix":"edgesuite.net","edgeHostnameDomain":"example.com.edgesuite.net","edgeHostnameId":"ehn_887436","ipVersionBehavior":"IPV4","productId":"prd_Alta","secure":false}]},"groupId":"grp_54321"}