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.

Recipes

Open Recipe

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

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.

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 Network of activated hostnames, either STAGING or PRODUCTION.

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

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

accountId

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*

currentSort

string

required

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

hostname:a hostname:d

defaultSort

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.

currentItemCount

integer

required

≥ 0

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

items

array

required

Each hostname.

items*

nextLink

string

required

For paginated responses, this links to the next set of response items.

previousLink

string

For paginated responses, this links to the next set of response items.

totalItems

integer

required

≥ 0

The total count of items returned for the requested criteria.

Headers

object

X-Limit-Default-Certs-Per-Contract-Limit

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.

X-Limit-Default-Certs-Per-Contract-Remaining

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.

X-RateLimit-Limit

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.

X-RateLimit-Remaining

integer

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

Language

AUTHENTICATE & TRY IT

To run this code or try it in Postman, set up your authentication credentials.

Not familiar with Postman? Learn how to use collections.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/papi/v1/hostnames \
# Add Authorization header to this snippet
3
     --header 'PAPI-Use-Prefixes: true' \
4
     --header 'accept: application/json'


xxxxxxxxxx
53
}
1
{
2
  "accountId": "act_A-CCT5678",
3
  "availableSort": [
4
    "hostname:a",
5
    "hostname:d"
6
  ],
7
  "currentSort": "hostname:a",
8
  "defaultSort": "hostname:a",
9
  "hostnames": {
10
    "currentItemCount": 3,
11
    "items": [
12
      {
13
        "cnameFrom": "www.example.com",
14
        "contractId": "ctr_K-0N7RAK7",
15
        "groupId": "grp_12345",
16
        "propertyId": "prp_123345",
17
        "propertyName": "example.com",
18
        "propertyType": "TRADITIONAL",
19
        "stagingCertType": "CPS_MANAGED",
20
        "stagingCnameTo": "www.example.com.edgekey.net",
21
        "stagingCnameType": "EDGE_HOSTNAME",
22
        "stagingEdgeHostnameId": "ehn_895822"
23
      },
24
      {
25
        "cnameFrom": "www.example2.com",

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.