List property hostname activations
GET https://{{host}}/papi/v1/properties/:propertyId/hostname-activations
For a property with useHostnameBucket set to true at creation, this lists the activations for all hostnames in the property's hostname bucket, on both production and staging networks. To view paginated results, use the response's nextLink and previousLink.
Request Params
| 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. | |
contractId | string | (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. | |
groupId | string | (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. | |
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
{"accountId":"act_A-CCT5678","contractId":"ctr_K-0N7RAK71","currentItemCount":2,"groupId":"grp_54321","hostnameActivations":{"items":[{"activationType":"ACTIVATE","hostnameActivationId":"atv_1696985","network":"STAGING","note":"Sample activation","notifyEmails":["you@example.com","them@example.com"],"propertyId":"prp_173136","propertyName":"example.com","propertyVersion":1,"status":"ACTIVE","submitDate":"2014-03-05T02:22:12Z","updateDate":"2014-03-04T21:12:57Z"},{"activationType":"ACTIVATE","hostnameActivationId":"atv_1696986","network":"PRODUCTION","note":"Sample activation","notifyEmails":["you@example.com","them@example.com"],"propertyId":"prp_173136","propertyName":"example.com","propertyVersion":1,"status":"PENDING","submitDate":"2014-03-02T02:22:12Z","updateDate":"2014-03-01T21:12:57Z"}]},"nextLink":"/papi/v1/properties/prp_173136/hostnames-activation?offset=2\u0026groupId=grp_15225\u0026contractId=ctr_K-0N7RAK7\u0026limit=2","totalItems":4}