List hostnames for a property

This operation lists active property hostnames assigned to a specific property. Use the optional query parameters to paginate, sort, and filter the results. You can nest and combine filters to obtain desired results. To view paginated results, use the response's nextLink and previousLink. You can call this operation by specifying any of the propertyId members from a list of properties, or by running a GET on the propertyLink response when creating a new property.

Recipes
List hostnames for a property
Open Recipe
Path Params
string
required

Unique identifier for the property. See ID prefixes for details on omitting the value's prp_ prefix.

Query Params
integer
≥ 0

For paginated responses, specifies the page of results you want to navigate to, starting from 0.

integer
≥ 1

For paginated responses, specifies the number of hostnames objects to include on each page.

string
Defaults to hostname:a

Enum Sort the results based on the cnameFrom value, either hostname:a for ascending or hostname:d for descending order. The default is hostname:a.

string

Filter the results by cnameFrom. Supports wildcard matches with *.

string

Filter the results by edge hostname. Supports wildcard matches with *.

string

Enum Network of activated hostnames, either STAGING or PRODUCTION.

boolean
Defaults to false

Limited availability Whether the response should include the certificate status for the hostname on staging and production networks.

string

Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it along with the groupId. In other operations that don't specify a propertyId URL parameter, this parameter is always required. See ID prefixes for details on omitting the value's ctr_ prefix.

string

Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along with the contractId. In other operations that don't specify a propertyId URL parameter, this parameter is always required. See ID prefixes for details on omitting the value's grp_ prefix.

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
required

Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs.

Responses

Response body
object
string

Identifies the prevailing account under which you requested the data. See ID prefixes for details on how to omit the ID's act_ prefix.

availableSort
array of strings
length ≥ 1

Available sorting options: hostname:a for ascending, and hostname:d for descending.

availableSort
string

Identifies the prevailing contract under which you requested the data. See ID prefixes for details on how to omit the ID's ctr_ prefix.

string

The sorting criteria applied to the response, either hostname:a for ascending, or hostname:d for descending.

hostname:a hostname:d

string
Defaults to hostname:a

If no query parameters were specified in the request, this shows the default hostname:a sorting criteria.

string

Identifies the group under which you requested the data. See ID prefixes for details on how to omit the ID's grp_ prefix.

hostnames
object

The set of requested property hostnames, available within an items array.

integer
required

The total count of items present in the current response body for requested criteria.

items
array of objects
required

Each entry specifies an active property hostname.

items*
object
certStatus
object

Limited availability With the includeCertStatus parameter set to true, determines whether a hostname is capable of serving secure content over the staging or production network.

string
required

The hostname that your end users see, indicated by the Host header in end user requests.

string

Only one supported EDGE_HOSTNAME value.

EDGE_HOSTNAME

string

Indicates the certificate's provisioning type. Either CPS_MANAGED type for the certificates you create with the Certificate Provisioning System API (CPS), or DEFAULT for the Default Domain Validation (DV) certificates created automatically. Note that you can't specify the DEFAULT value if your property hostname uses the akamaized.net domain suffix.

CPS_MANAGED DEFAULT

string

The edge hostname you point the property hostname to so that you can start serving traffic through Akamai servers. This member corresponds to the edge hostname object's edgeHostnameDomain member.

string

Identifies each edge hostname. See ID prefixes for details on how to omit the ID's ehn_ prefix.

string

Indicates the certificate's provisioning type. Either CPS_MANAGED type for the certificates you create with the Certificate Provisioning System API (CPS), or DEFAULT for the Default Domain Validation (DV) certificates created automatically. Note that you can't specify the DEFAULT value if your property hostname uses the akamaized.net domain suffix.

CPS_MANAGED DEFAULT

string

The edge hostname you point the property hostname to so that you can start serving traffic through Akamai servers. This member corresponds to the edge hostname object's edgeHostnameDomain member.

string

Identifies each edge hostname. See ID prefixes for details on how to omit the ID's ehn_ prefix.

string
string
integer
required

The total count of items for requested criteria.

string

Unique identifier for the property. See ID prefixes for details on how to omit the ID's prp_ prefix. Don't use this value if you want to exchange data with the Identity and Access Manager API. See Manage properties and includes.

string

A unique, descriptive name for the property. It's not modifiable after you initially create it on a POST request.

Headers
object
integer

Maximum sustainable number of request allowed each minute per account. This rate limit protects PAPI resources from being exhausted by single users. Once you exceed the limit, you receive the 429 error. If you call PAPI using multiple API clients within the same account, the rate limit applies globally to all API clients.

This API also provides a burst limit that specifies how many requests you can make in excess of the imposed rate limit. The one-time burst limit is 1000 requests. Once you consume all available resources, the burst capacity increases steadily by 100 requests every minute, until it reaches its initial maximum limit of 1000.

integer

Remaining number of requests allowed each minute per account. See Rate and resource limiting for details.

Language
Authentication
URL