Activate or deactivate a property

post

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

This operation creates a new property activation, which deactivates any currently active version. After a necessary delay, this activates your property version's rule tree and set of hostnames across Akamai's network of edge servers, modifying how your edge content responds to end-user requests.

If your account is enabled for mandatory domain validation, you need to prove ownership of the domains you set up as property hostnames, before activating the property. You can either pre-validate your domains by generating validation challenges or use the challenges you get while adding, listing, or updating your property version hostnames. Learn more.

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.

If there's a problem with the property you activated, you may have the option to fall back to the previous version. To build the request object, go to the activationLink from the activation's response and note down the fallbackVersion value. Within an hour of activating, POST another activation with propertyVersion set to the version you noted down and useFastFallback set to true. This disables the current activation and falls back to the specified version. A fallback takes a few seconds, but the option is available only if there have been no changes to the set of property hostnames, as indicated by canFastFallback.

Path Params

propertyId

string

required

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

Query Params

contractId

string

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

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

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.

Body Params

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

acknowledgeAllWarnings

boolean

Defaults to false

When POSTing an activation, you can skip acknowledging each warning. With this enabled, you can omit the acknowledgeWarnings array.

acknowledgeWarnings

array of strings

String IDs prefixed with msg_ to acknowledge any warnings noted in responses to previous activation requests.

acknowledgeWarnings

activationType

string

enum

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, it would no longer serve any traffic. You'd need to modify your DNS configuration and specify a different way to field the traffic.

Allowed:

delayValidations

boolean | null

This makes the operation respond with an activationLink more quickly. Some time-consuming validations ordinarily result in a direct error response. Enabling this delays them so that any errors appear later once you Get a property activation. In that case, the activation's status is FAILED.

fastPush

boolean

Defaults to true

Enable a fast metadata push when activating a new property, true by default.

ignoreHttpErrors

boolean

Defaults to true

Ignore any HTTP errors when pushing fast metadata activation, true by default.

network

string

enum

required

The network to activate on, either STAGING or PRODUCTION.

Allowed:

note

string

A descriptive log comment.

notifyEmails

array of strings

required

length ≥ 1

Email addresses to notify when the activation status changes.

notifyEmails*

propertyVersion

integer

required

≥ 1

The version of the property to activate.

useFastFallback

boolean

Defaults to false

After activating a property and finding it causes problems, POSTing another activation within one hour with useFastFallback enabled quickly rolls back to the previous version. This option is only available for activations where canFastFallback is true.

201The response provides a URL link to the newly created activation.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method not allowed.

406Not acceptable.

409Conflict.

415Unsupported media type.

422Unprocessable content.

429Too many requests.

500Internal server error.