List hostnames for an account

get

https://{hostname}/papi/v1/hostnames

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.

Query Params

offset

integer

≥ 0

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

limit

integer

≥ 1

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

sort

string

enum

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.

Allowed:

hostname

string

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

cnameTo

string

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

network

string

enum

Enum Network of activated hostnames, either STAGING or PRODUCTION.

Allowed:

contractId

string

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

groupId

string

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

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

200The response lists property hostnames for properties in a current account.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method not allowed.

406Not acceptable.

429Too many requests.

500Internal server error.