List hostnames for an account

This operation lists active property hostnames for all properties available in an account. 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.

Recipes
List hostnames for an account
Open Recipe
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.

string

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

string

Unique identifier for the group. 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
required

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
required
length ≥ 1

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

availableSort*
string
required

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

hostname:a hostname:d

string
required
Defaults to hostname:a

If you didn't specify any query parameters in the request, this shows the default hostname:a sorting criteria.

hostnames
object
required

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

integer
required
≥ 0

The number of items present in the current response body view.

items
array
required

Each hostname.

items*
string
required
string
integer
required
≥ 0

The total count of items returned for the requested criteria.

Headers
object
string

The total number of Default Domain Validation (DV) certificates per contract. This header only appears if you have any hostnames with Default DV certificates assigned to the property version.

string

The number of remaining Default Domain Validation (DV) certificates per contract. This header only appears if you have any hostnames with Default DV certificates assigned to the property version.

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

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

Language
AUTHENTICATE & TRY IT
URL