Number of APIs: 4
1. 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
.
2. List property's activations
GET https://{{host}}/papi/v1/properties/:propertyId/activations
This lists all activations for all versions of a property, on both production and staging networks.
GET https://{{host}}/papi/v1/properties/:propertyId/activations/:activationId
Gets details about an activation. You typically get a single activation from an 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.activationLink
when launching a new activation and following up to poll its status
. For activations whose status
is PENDING
, a Retry-After
header provides an estimate for when it's likely to change.
4. Cancel a property's pending activation
DELETE https://{{host}}/papi/v1/properties/:propertyId/activations/:activationId
If you detect a problem with a property version while its activation is still PENDING
, use this operation to cancel it. Make a DELETE request on the activationLink
you get from the Activate 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. If there are unexpected problems with an activation that goes live before you're able to cancel it, you often have a one-hour window to quickly fall back to a previous activation. See Activate or deactivate a property for details.
ENDPOINTS