Get a property activation
GET https://{{host}}/papi/v1/properties/:propertyId/activations/:activationId
Gets details about an activation. You typically get a single activation from an activationLink when launching a new activation and following up to poll its status. For activations whose status is PENDING, a Retry-After header provides an estimate for when it's likely to change.
Note: To reduce errors, avoid calling PAPI with separate clients on the same data. Avoid frequently polling status values. Instead, progressively increase the delay between calls.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
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-CCT7890","activations":{"items":[{"activationId":"atv_1696985","activationType":"ACTIVATE","fallbackInfo":{"canFastFallback":true,"fallbackVersion":10,"fastFallbackAttempted":false,"fastFallbackExpirationTime":1506451772,"fastFallbackRecoveryState":null,"steadyStateTime":1506448172},"fmaActivationState":"steady","network":"STAGING","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"}]},"contractId":"ctr_C-0N7RAC71","groupId":"grp_54321"}