API
Start typing to search…

Create a custom rule

post
https://{hostname}/appsec/v1/configs//custom-rules

All products Creates a new custom rule.

Path Params
int64
required

A unique identifier for each configuration.

Query Params
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
conditions
array of objects

Contains the details about the condition that triggers the custom rule.

conditions
string

The custom rule description.

effectiveTimePeriod
object

The time period during which the custom rule is active.

integer

Uniquely identifies the rule.

boolean

Whether to inspect the HTTP request for unstructured custom rules.

boolean

Whether to inspect the HTTP response for unstructured custom rules.

loggingOptions
array of objects

The specific conditions to be logged.

loggingOptions
string

The metadata you provided for unstructured custom rules.

string
required

The custom rule name.

string
enum
required

Specify AND logic to require all conditions, or OR logic to require at least one condition to match.

Allowed:
boolean

Whether the rule is active in the configuration.

integer
0 to 100

The portion of traffic to sample, expressed as a percent.

boolean
Defaults to false

Whether to show traffic from only the staging network, or all traffic. The default setting is false and only shows in the response when true.

boolean
required

Whether you created the rule with the structured custom rule builder or free-form XML. This needs to be true.

tag
array of strings

The list of labels you assigned to the custom rule.

tag
integer

The custom rule version.

Response

Updated about 1 month ago

Language
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 1 month ago