Qodex.ai

Get a property hostname activation

GET https://{{host}}/papi/v1/properties/:propertyId/hostname-activations/:hostnameActivationId?contractId={{contractId}}&groupId={{groupId}}

For a property with useHostnameBucket set to true at creation, this operation gets details about a specific property hostname activation. You typically get a single activation from an activationLink when launching a new property hostname activation and following up to poll its status. For property hostname activations whose status is PENDING, a Retry-After header provides an estimate for when it's likely to change.

Request Params

KeyDatatypeRequiredDescription
includeHostnamesstring(Optional) Whether the response should include the property hostnames associated with an activation and the related certificate status on staging and production networks.
contractIdstring(Required) Unique identifier for the contract. See ID prefixes for details on omitting the value's ctr_ prefix.
groupIdstring(Required) Unique identifier for the group. 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-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"}