Activate an FAI configuration version

post

https://{hostname}/appsec/v1/fai-configurations/{faiConfigId}/versions/{version}/activate

This activates a specific version of an FAI configuration, which deploys it and starts enforcing its rules. The call takes no request body, and the Location header of the response gives you the URL of the activation record. Activation completes before the response returns, so the record's status is already the final result, SUCCEEDED or FAILED. A successful activation is permanent. There's no deactivate operation, the version becomes read-only, and the configuration counts against the maxActiveFaiConfigs limit reported by the Get numeric constraints operation. To carry on from an active version, clone it, edit the clone, then activate the clone.

Responses

Language

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

201The response provides the activation record, with the status of the activation.

400Bad request. The request isn't valid, for example an id that isn't a number, a missing or out-of-range field, a value that isn't allowed, or rule settings that conflict. The detail names the field, the value sent, and what to change.

401Unauthorized.

403Forbidden. You don't have the access this operation needs, or your account isn't entitled to a feature the request uses, such as a rule, the MODIFY action, or languages. The detail says which access or entitlement to ask for.

404Not found. A resource in the URL doesn't exist: the configuration, version, custom PII type, application, access key, or activation. The detail names the missing id and where to find valid ones.

409Conflict. The version can't be activated right now. Either it's already active, another version of the configuration is pending activation, or the account has reached its activation limit.

500Internal server error. Deploying the version failed, and its activationStatus is now FAILED, or something else failed on Akamai's side. Activate it again. If it keeps failing, contact Akamai support with the instance value.