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.

Recipes

Open Recipe

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

required

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

Responses

Response body

object

accountId

string

length ≥ 1

Identifies the prevailing account under which you requested the data. See ID prefixes for details on how to omit the ID's act_ prefix.

activations

object

The set of activated hostnames.

Has additional fields

contractId

string

length ≥ 1

Identifies the prevailing contract under which you requested the data. See ID prefixes for details on how to omit the ID's ctr_ prefix.

groupId

string

length ≥ 1

Identifies the prevailing group under which you requested the data. See ID prefixes for details on how to omit the ID's grp_ prefix.

hostnameActivations

object

The set of requested property hostname activations, available within an items array.

currentItemCount

integer

≥ 0

The number of items present in the current response body view.

items

array of objects

Activated property hostnames on a specific network. Relevant response objects appear within the outer envelope's activations.items array.

items

object

accountId

string

Identifies the prevailing account under which you requested the data. See ID prefixes for details on how to omit the ID's act_ prefix.

activationId

string

The property hostname activation's unique identifier. See ID prefixes for details on how to omit the ID's atv_ prefix.

activationType

string

required

Defaults to ACTIVATE

Either ACTIVATE or DEACTIVATE. The default is ACTIVATE. Any new activation automatically deactivates the current activation. Note that if you were to POST a DEACTIVATE type on an active property hostname, it would no longer serve any traffic. You'd need to modify your DNS configuration and specify a different way to field the traffic.

ACTIVATE DEACTIVATE

fallbackInfo

object

Encapsulates information about fast fallback. You can use it to fall back to a previous activation when POSTing an activation with useFastFallback enabled.

fmaActivationState

string

Indicates fast metadata activation state. A value of steady indicates the property is currently active or has been cancelled. Values of received, lived, and deployed represent progressive stages of activation, while cancelling happens either after failing a network safety check or in response to a DELETE operation. Note that the status member indicates whether the activation is live.

steady received lived deployed cancelling

groupId

string

Identifies the prevailing group under which you requested the data. See ID prefixes for details on how to omit the ID's grp_ prefix.

hostnameActivationId

string

The property hostname activation's unique identifier. See ID prefixes for details on how to omit the ID's atv_ prefix.

network

string

required

The network to activate on, either STAGING or PRODUCTION.

STAGING PRODUCTION

note

string

required

Assigns a log message to the activation request.

notifyEmails

array of strings

required

length ≥ 0

Email addresses to notify when the activation status changes.

notifyEmails*

propertyId

string

required

Unique identifier for the property with the hostname bucket the activated property hostnames belong to. See ID prefixes for details on how to omit the ID's prp_ prefix. Don't use this value if you want to exchange data with the Identity and Access Manager API. See Manage properties and includes.

propertyName

string

required

A descriptive name for the property with the hostname bucket the activated property hostnames belong to.

propertyVersion

integer

≥ 1

The property version targeted with activation. Once activated, you can no longer modify that version of the property.

status

string

required

The activation's status. ACTIVE if currently serving traffic. INACTIVE if another activation has superseded this one. PENDING if not yet active. ABORTED if the client followed up with a DELETE request in time. FAILED if the activation causes a range of edge network errors that may cause a fallback to the previous activation. PENDING_DEACTIVATION or DEACTIVATED when the activationType is DEACTIVATE to no longer serve traffic.

ACTIVE INACTIVE PENDING ABORTED FAILED DEACTIVATED PENDING_DEACTIVATION

submitDate

string

required

Read-only A date stamp marking when the activation initiated.

updateDate

string

required

Read-only A date stamp marking when the status last changed.

nextLink

string

For paginated responses, this links to the next set of response items.

previousLink

string

For paginated responses, this links to the next set of response items.

totalItems

integer

≥ 0

The total count of items returned for the requested criteria.

Headers

object

X-RateLimit-Limit

integer

Maximum sustainable number of request allowed each minute per account. This rate limit protects PAPI resources from being exhausted by single users. Once you exceed the limit, you receive the 429 error. If you call PAPI using multiple API clients within the same account, the rate limit applies globally to all API clients.

This API also provides a burst limit that specifies how many requests you can make in excess of the imposed rate limit. The one-time burst limit is 1000 requests. Once you consume all available resources, the burst capacity increases steadily by 100 requests every minute, until it reaches its initial maximum limit of 1000.

X-RateLimit-Remaining

integer

Remaining number of requests allowed each minute per account. See Rate and resource limiting for details.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request DELETE \
2
     --url https://hostname/papi/v1/properties/propertyId/hostname-activations/hostnameActivationId \
3
     --header 'PAPI-Use-Prefixes: true' \
4
     --header 'accept: application/json'


xxxxxxxxxx
24
 
1
{
2
  "hostnameActivations": {
3
    "items": [
4
      {
5
        "accountId": "act_A-CCT5678",
6
        "activationType": "ACTIVATE",
7
        "groupId": "grp_32145",
8
        "hostnameActivationId": "atv_1696985",
9
        "network": "STAGING",
10
        "note": "Sample activation cancellation",
11
        "notifyEmails": [
12
          "you@example.com",
13
          "them@example.com"
14
        ],
15
        "propertyId": "prp_173136",
16
        "propertyName": "example.com",
17
        "propertyVersion": 1,
18
        "status": "ABORTED",
19
        "submitDate": "2014-03-02T02:22:12Z",
20
        "updateDate": "2014-03-01T21:12:57Z"
21
      }
22
    ]
23
  }
24
}

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.