Get an edge hostname

get

https://{hostname}/papi/v1/edgehostnames/{edgeHostnameId}

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.

Path Params

edgeHostnameId

string

required

Unique identifier for the edge hostname. See ID prefixes for details on omitting the value's ehn_ prefix.

Query Params

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

Currently the only supported option is mapDetails that enables extra mapping-related information. See Site Shield API for more information.

accountSwitchKey

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.

Headers

PAPI-Use-Prefixes

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

Loading…

Response

Choose an example:

application/json

application/problem+json

200The response shows the specified edge hostname.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method not allowed.

406Not acceptable.

429Too many requests.

500Internal server error.