Update a configuration version

put

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

This updates the settings and rules of a configuration version. The request replaces the version in full, so send the complete set of values you want it to have: anything you leave out is cleared, omitted rules are removed, and omitted booleans fall back to their defaults. Only versions with an activationStatus of INACTIVE or FAILED can be edited, since activating a version freezes it permanently. To change a configuration that is already active, clone its active version with the Clone an FAI configuration version operation, update the clone, then activate the clone.

Path Params

faiConfigId

string

required

^[0-9]+$

Identifier for the FAI configuration.

version

integer

required

Version number of the FAI configuration.

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

Represents a specific version of a Firewall for AI configuration, including its security rules, activation status, and version metadata.

defaultDenyResponse

string

length ≤ 1024

The default response body returned when a request is denied by any rule configured with a DENY action and without its own presetResponse. Ignored on API type configurations.

defaultModifiedResponse

object

The default modified response definition, used by any rule or PII entity with a MODIFY action that does not carry its own modifiedResponse. A MODIFY action that resolves to no modified response at all is rejected when you save the version, not when you activate it.

logInput

boolean

Defaults to true

Whether input logging is enabled. When true, all input prompts to the LLM are logged.

logOutput

boolean

Defaults to true

Whether output logging is enabled. When true, all LLM responses are logged.

maskInputPiiFields

boolean

Defaults to true

Whether PII fields are masked in input logs. When true, it redacts detected PII in prompts.

maskOutputPiiFields

boolean

Defaults to true

Whether PII fields are masked in output logs. When true, it redacts detected PII in responses.

rules

array of objects

The security rules configured for this version, including sensitivity, size, PII, or off-topic rules depending on the rule type. Run List FAI rule types operation for available rules.

rules

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

200The response provides the updated configuration version.

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 configuration version can no longer be edited, because its activationStatus isn't INACTIVE or FAILED. Clone the version with the Clone an FAI configuration version operation, then edit the clone.

500Internal server error. Something failed on Akamai's side. Try again later. If it keeps happening, contact Akamai support with the instance value.