Cancel a pending property hostname activation

delete

https://{hostname}/papi/v1/properties/{propertyId}/hostname-activations/{hostnameActivationId}

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.

Path Params

propertyId

string

required

Unique identifier for the property. See ID prefixes for details on omitting the value's prp_ prefix.

hostnameActivationId

string

required

Unique identifier for the hostname activation.

Query Params

contractId

string

required

Unique identifier for the contract. See ID prefixes for details on omitting the value's ctr_ prefix.

groupId

string

required

Unique identifier for the group. See ID prefixes for details on omitting the value's grp_ prefix.

accountSwitchKey

string

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

PAPI-Use-Prefixes

string

enum

required

Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

200The response shows a status of the cancelled hostname activation for the specified property.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method not allowed.

406Not acceptable.

409Conflict.

422Unprocessable content.

429Too many requests.

500Internal server error.