Activate a configuration version

post

https://{hostname}/appsec/v1/activations

All products Activates one or more configurations globally. Note that you need to explicitly list any invalid hosts in the acknowledgedInvalidHostsByConfig parameter in order to successfully activate a configuration that includes invalid hostnames. If you have an invalid hostname that isn't explicitly called out you'll receive an error telling you to add them to acknowledgedInvalidHostsByConfig. See Activate with invalid hostnames for instructions.

Query Params

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

acknowledgedInvalidHosts

array of strings

The list of invalid hostnames in the security configuration to activate. In some cases, you may want to activate a security configuration with hostnames that WAF can't protect (for example, hostnames not managed as Akamai properties, or managed under a different contract than the configuration). By default, the existence of invalid hostnames blocks activation with a warning. The warning includes the names of the invalid hostnames. If you want to activate a configuration with invalid hostnames, enter the hostnames in this array. This field is now deprecated. Use acknowledgedInvalidHostsByConfig instead.

acknowledgedInvalidHosts

acknowledgedInvalidHostsByConfig

array of objects

The list of invalid hostnames per security configuration to activate. In some cases, you may want to activate a security configuration with hostnames that WAF can't protect (for example, hostnames not managed as Akamai properties, or managed under a different contract than the configuration). By default, the existence of invalid hostnames blocks activation with a warning. The warning includes the names of the invalid hostnames. If you want to activate a configuration with invalid hostnames, enter the hostnames and the configuration ID in this array.

acknowledgedInvalidHostsByConfig

action

string

enum

required

The action to take, either ACTIVATE or DEACTIVATE.

Allowed:

activationConfigs

array of objects

required

length between 1 and 2

Specifies the security configuration and version to activate or deactivate.

activationConfigs*

configId

integer

required

The origin identifier or destination configuration to activate.

configVersion

integer

required

The origin version or destination configuration to activate.

network

string

enum

required

The target Akamai activation environment, either STAGING or PRODUCTION.

Allowed:

note

string

required

The notes you entered for the activation.

notificationEmails

array of strings

required

The email addresses to notify when the activation happens.

notificationEmails*

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Activation request successful.

202Activation request launched.

400Bad request. Invalid request body or URL parameter input.

403Forbidden. You don't have access to the configuration.