List hostnames for an account

GET https://{{host}}/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.

Request Params

Key	Datatype	Description
`offset`	string	(Optional) For paginated responses, specifies the page of results you want to navigate to, starting from `0`.
`limit`	string	(Optional) For paginated responses, specifies the number of `hostnames` objects to include on each page.
`sort`	string	(Optional) 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`.
`hostname`	string	(Optional) Filter the results by `cnameFrom`. Supports wildcard matches with `*`.
`cnameTo`	string	(Optional) Filter the results by edge hostname. Supports wildcard matches with `*`.
`network`	string	(Optional) Enum Network of activated hostnames, either `STAGING` or `PRODUCTION`.
`contractId`	string	(Optional) Unique identifier for the contract. See ID prefixes for details on omitting the value's `ctr_` prefix.
`groupId`	string	(Optional) Unique identifier for the group. See ID prefixes for details on omitting the value's `grp_` prefix.
`accountSwitchKey`	string	(Optional) 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

Key	Datatype	Required	Description
`PAPI-Use-Prefixes`	string		(Required) Enum Sets whether to represent ID prefixes in response data. Set to `false` when exchanging PAPI data with other APIs.
`Accept`	string

RESPONSES

status: OK

{&quot;accountId&quot;:&quot;act_A-CCT5678&quot;,&quot;availableSort&quot;:[&quot;hostname:a&quot;,&quot;hostname:d&quot;],&quot;currentSort&quot;:&quot;hostname:a&quot;,&quot;defaultSort&quot;:&quot;hostname:a&quot;,&quot;hostnames&quot;:{&quot;currentItemCount&quot;:3,&quot;items&quot;:[{&quot;cnameFrom&quot;:&quot;www.example.com&quot;,&quot;contractId&quot;:&quot;ctr_K-0N7RAK7&quot;,&quot;groupId&quot;:&quot;grp_12345&quot;,&quot;propertyId&quot;:&quot;prp_123345&quot;,&quot;propertyName&quot;:&quot;example.com&quot;,&quot;propertyType&quot;:&quot;TRADITIONAL&quot;,&quot;stagingCertType&quot;:&quot;CPS_MANAGED&quot;,&quot;stagingCnameTo&quot;:&quot;www.example.com.edgekey.net&quot;,&quot;stagingCnameType&quot;:&quot;EDGE_HOSTNAME&quot;,&quot;stagingEdgeHostnameId&quot;:&quot;ehn_895822&quot;},{&quot;cnameFrom&quot;:&quot;www.example2.com&quot;,&quot;contractId&quot;:&quot;ctr_C-0N7RAC71&quot;,&quot;groupId&quot;:&quot;grp_54321&quot;,&quot;productionCertType&quot;:&quot;DEFAULT&quot;,&quot;productionCnameTo&quot;:&quot;www.example2.com.edgekey.net&quot;,&quot;productionCnameType&quot;:&quot;EDGE_HOSTNAME&quot;,&quot;productionEdgeHostnameId&quot;:&quot;ehn_895825&quot;,&quot;propertyId&quot;:&quot;prp_123424&quot;,&quot;propertyName&quot;:&quot;example2.com&quot;,&quot;propertyType&quot;:&quot;TRADITIONAL&quot;},{&quot;cnameFrom&quot;:&quot;www.example3.com&quot;,&quot;contractId&quot;:&quot;ctr_K-0N7RAK7&quot;,&quot;groupId&quot;:&quot;grp_54321&quot;,&quot;productionCertType&quot;:&quot;DEFAULT&quot;,&quot;productionCnameTo&quot;:&quot;www.example3.com.edgekey.net&quot;,&quot;productionCnameType&quot;:&quot;EDGE_HOSTNAME&quot;,&quot;productionEdgeHostnameId&quot;:&quot;ehn_895833&quot;,&quot;propertyId&quot;:&quot;prp_123424&quot;,&quot;propertyName&quot;:&quot;example3.com&quot;,&quot;propertyType&quot;:&quot;HOSTNAME_BUCKET&quot;}],&quot;nextLink&quot;:&quot;/papi/v1/hostnames?offset=3\u0026limit=3&quot;,&quot;previousLink&quot;:&quot;/papi/v1/hostnames?offset=0\u0026limit=3&quot;,&quot;totalItems&quot;:17}}