Update a configuration version

put

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

Modify the settings and rules of a configuration version. Only versions that are not currently active can be edited, where canEdit=true. Update is used then to set the version values.

Path Params

faiConfigId

string

required

Unique 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

object

The default response returned when a request is denied by any rule configured with a DENY action. Ignored for API type configurations.

defaultModifiedResponse

object

The default modified response definition. Required before any rule or PII entity can use the MODIFY action. Ignored for API type configurations.

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, detected PII in prompts is redacted before logging.

maskOutputPiiFields

boolean

Defaults to true

Whether PII fields are masked in output logs. When true, detected PII in responses is redacted before logging.

rules

array of objects

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

rules

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Configuration version updated successfully.

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

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

404Not found. That resource doesn't exist, or the URL is malformed.

422Unprocessable content.

500Internal server error.