Activate or deactivate an include

post

https://{hostname}/papi/v1/includes/{includeId}/activations

Limited availability This operation creates a new include activation, which deactivates any current activation. After a necessary delay, this activates your version's rule tree 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.

Path Params

includeId

string

required

Unique identifier for the include. See ID prefixes for details on omitting the value's inc_ 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

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 include, 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

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 an include activation. In that case, the activation's status is FAILED.

ignoreHttpErrors

boolean

Defaults to true

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

includeVersion

integer

required

≥ 1

The version of the include to activate.

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*

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.