Qodex.ai

Cancel a pending property hostname activation

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

For a property with useHostnameBucket set to true when created, if you detect a problem with a property hostname while its activation is still PENDING, use this operation to cancel it. Make a DELETE request on the activationLink you get from the Add or remove hostnames for a property operation's response. Once you DELETE the activation, it no longer appears in the list of activations, but you can still access it individually.

Request Params

KeyDatatypeRequiredDescription
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

{"hostnameActivations":{"items":[{"accountId":"act_A-CCT5678","activationType":"ACTIVATE","groupId":"grp_32145","hostnameActivationId":"atv_1696985","network":"STAGING","note":"Sample activation cancellation","notifyEmails":["you@example.com","them@example.com"],"propertyId":"prp_173136","propertyName":"example.com","propertyVersion":1,"status":"ABORTED","submitDate":"2014-03-02T02:22:12Z","updateDate":"2014-03-01T21:12:57Z"}]}}