Activate or deactivate a property
POST https://{{host}}/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. 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
.
Body
PARAM
Key | Datatype | Required | Description |
contractId
|
string | (Optional) 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](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix. | |
groupId
|
string | (Optional) 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](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix. | |
accountSwitchKey
|
string | (Optional) For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). |
HEADERS
Key | Datatype | Required | Description |
PAPI-Use-Prefixes
|
string | (Required) __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to `false` when exchanging PAPI data with other APIs. | |
Content-Type
Curl curl -X POST 'https://host/papi/v1/properties/:propertyId/activations?contractId=&groupId=&accountSwitchKey=' -H 'PAPI-Use-Prefixes: PAPI-Use-Prefixes' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"acknowledgeWarnings":["msg_baa4560881774a45b5fd25f5b1eab021d7c40b4f"],"network":"STAGING","note":"Sample activation","notifyEmails":["you@example.com","them@example.com"],"propertyVersion":1,"useFastFallback":false}' ENDPOINTS |