Get an edge hostname
GET https://{{host}}/papi/v1/edgehostnames/:edgeHostnameId?contractId={{contractId}}&groupId={{groupId}}
This polls the state of an edge hostname, typically after creating a new edge hostname. The response tells you whether the CNAME has been fully distributed across the network. If the hostname's status is ACTIVE, the process is complete. Until then, you typically see values of ZONE1, ZONE2, ZONE3, or simply PENDING.
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-CCT7890","contractId":"ctr_C-0N7RAC71","edgeHostnames":{"items":[{"domainPrefix":"example.com","domainSuffix":"edgesuite.net","edgeHostnameDomain":"example.com.edgesuite.net","edgeHostnameId":"ehn_887436","ipVersionBehavior":"IPV4","productId":"prd_Alta","secure":false,"useCases":[{"option":"BACKGROUND","type":"GLOBAL","useCase":"Download_Mode"}]}]},"groupId":"grp_32145"}