List hostnames for a property
GET https://{{host}}/papi/v1/properties/:propertyId/hostnames
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.
Body
PARAM
Key | Datatype | Required | 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`. | |
includeCertStatus
|
string | (Optional) __Limited availability__ Whether the response should include the certificate status for the hostname on sta Curl curl -X GET 'https://host/papi/v1/properties/:propertyId/hostnames?offset=&limit=&sort=&hostname=&cnameTo=&network=&includeCertStatus=&contractId=&groupId=&accountSwitchKey=' -H 'PAPI-Use-Prefixes: PAPI-Use-Prefixes' -H 'Accept: application/json' ENDPOINTS |