API

List edge hostnames

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

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.

Query Params
string
required

Unique identifier for the contract. See ID prefixes for details on omitting the value's ctr_ prefix.

string
required

Unique identifier for the group. See ID prefixes for details on omitting the value's grp_ prefix.

string

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

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
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

Updated 4 months ago

Language
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json

Updated 4 months ago