Qodex.ai

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.

Request Params

KeyDatatypeRequiredDescription
offsetstring(Optional) For paginated responses, specifies the page of results you want to navigate to, starting from 0.
limitstring(Optional) For paginated responses, specifies the number of hostnames objects to include on each page.
sortstring(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.
hostnamestring(Optional) Filter the results by cnameFrom. Supports wildcard matches with *.
cnameTostring(Optional) Filter the results by edge hostname. Supports wildcard matches with *.
networkstring(Optional) Enum Network of activated hostnames, either STAGING or PRODUCTION.
includeCertStatusstring(Optional) Limited availability Whether the response should include the certificate status for the hostname on staging and production networks.
contractIdstring(Optional) Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it along with the groupId. In other operations that don't specify a propertyId URL parameter, this parameter is always required. See ID prefixes for details on omitting the value's ctr_ prefix.
groupIdstring(Optional) Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along with the contractId. In other operations that don't specify a propertyId URL parameter, this parameter is always required. See ID prefixes for details on omitting the value's grp_ prefix.
accountSwitchKeystring(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

KeyDatatypeRequiredDescription
PAPI-Use-Prefixesstring(Required) Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs.
Acceptstring

RESPONSES

status: OK

{"accountId":"act_A-CCT1234","availableSort":["hostname:a","hostname:d"],"contractId":"ctr_C-0N7RAC71","currentSort":"hostname:a","defaultSort":"hostname:a","groupId":"grp_12345","hostnames":{"currentItemCount":3,"items":[{"cnameFrom":"example.com","cnameType":"EDGE_HOSTNAME","productionCertType":"DEFAULT","productionCnameTo":"example.com.edgekey.net","productionEdgeHostnameId":"ehn_895822"},{"cnameFrom":"m-example.com","cnameType":"EDGE_HOSTNAME","stagingCertType":"DEFAULT","stagingCnameTo":"m-example.com.edgekey.net","stagingEdgeHostnameId":"ehn_293412"},{"certStatus":{"authorization":{"dns01":{"result":{"message":"dns01 cps dry run cname/TXT incomplete","src":"CPS","timestamp":"2024-07-25T16:17:37Z"},"value":"dummy-unique-value-for-DNS-TXT-record"},"http01":{"body":"unique http body content","result":{"message":"http01 cps dry run fail reason","src":"CPS","timestamp":"2024-07-25T16:17:37Z"},"url":"/.well-known/acme-challenge/"},"status":"ATTEMPTING_VALIDATION","validUntil":"2024-07-25T16:17:37Z"},"certExpirationDate":"2024-07-25T16:17:37Z","production":[{"status":"PENDING"}],"staging":[{"status":"PENDING"}],"validationCname":{"hostname":"_acme-challenge.www.example.com","target":"{token}.www.example.com.akamai-domain.com"}},"cnameFrom":"example2.com","cnameType":"EDGE_HOSTNAME","stagingCertType":"DEFAULT","stagingCnameTo":"example2.com.edgekey.net","stagingEdgeHostnameId":"ehn_895822"}],"nextLink":"/papi/v1/properties/prp_175780/hostnames?offset=1\u0026groupId=grp_15225\u0026contractId=ctr_K-0N7RAK71\u0026limit=3","totalItems":4},"propertyId":"prp_175780","propertyName":"mytestproperty.com"}