SmartWebSecurity WAF API, REST: WafProfile.Update

Статья создана

Yandex Cloud

Улучшена

Tania L.

Обновлена 28 мая 2026 г.

HTTP request
Path parameters
Body parameters
CoreRuleSet
RuleSet
WafProfileRule
WafProfileExclusionRule
Condition
AuthorityMatcher
StringMatcher
ListsMatchers
ListsMatcher
HttpMethodMatcher
RequestUriMatcher
QueryMatcher
HeaderMatcher
IpMatcher
IpRangesMatcher
GeoIpMatcher
AsnRangesMatcher
CookieMatcher
BotCategoryMatcher
BotNameMatcher
BotScoreMatcher
IntMatcher
IntLEMatcher
IntGEMatcher
IntEQMatcher
IntNEMatcher
VerifiedBotMatcher
BoolMatcher
FingerPrintMatcher
ExcludeRules
RequestCondition
RequestParamMatcher
StringMatcher
HeaderMatcher
CookieMatcher
BodyMatcher
AnalyzeRequestBody
WafProfileRuleSet
WafProfileCoreRuleSet
WafProfileYaRuleSet
RuleGroup
WafProfileMlRuleSet
Response
Status

Updates the specified WAF profile.

HTTP request

PATCH https://smartwebsecurity.api.cloud.yandex.net/smartwebsecurity/v1/wafProfiles/{wafProfileId}

Path parameters

Field

Description

wafProfileId

string

Required field. ID of the WAF profile to update.

Body parameters

{
  // Includes only one of the fields `coreRuleSet`
  "coreRuleSet": {
    "inboundAnomalyScore": "string",
    "paranoiaLevel": "string",
    "ruleSet": {
      "name": "string",
      "version": "string",
      "type": "string",
      "id": "string"
    }
  },
  // end of the list of possible fields
  "updateMask": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "rules": [
    {
      "ruleId": "string",
      "isEnabled": "boolean",
      "isBlocking": "boolean"
    }
  ],
  "exclusionRules": [
    {
      "name": "string",
      "description": "string",
      "condition": {
        "authority": {
          "authorities": [
            {
              // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
              "exactMatch": "string",
              "exactNotMatch": "string",
              "prefixMatch": "string",
              "prefixNotMatch": "string",
              "pireRegexMatch": "string",
              "pireRegexNotMatch": "string",
              "defined": "boolean",
              "listsMatchers": {
                "strListsMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "strListsNotMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "regExpListsMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "regExpListsNotMatch": {
                  "listIds": [
                    "string"
                  ]
                }
              }
              // end of the list of possible fields
            }
          ],
          "authorityMatcher": {
            // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
            "exactMatch": "string",
            "exactNotMatch": "string",
            "prefixMatch": "string",
            "prefixNotMatch": "string",
            "pireRegexMatch": "string",
            "pireRegexNotMatch": "string",
            "defined": "boolean",
            "listsMatchers": {
              "strListsMatch": {
                "listIds": [
                  "string"
                ]
              },
              "strListsNotMatch": {
                "listIds": [
                  "string"
                ]
              },
              "regExpListsMatch": {
                "listIds": [
                  "string"
                ]
              },
              "regExpListsNotMatch": {
                "listIds": [
                  "string"
                ]
              }
            }
            // end of the list of possible fields
          }
        },
        "httpMethod": {
          "httpMethods": [
            {
              // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
              "exactMatch": "string",
              "exactNotMatch": "string",
              "prefixMatch": "string",
              "prefixNotMatch": "string",
              "pireRegexMatch": "string",
              "pireRegexNotMatch": "string",
              "defined": "boolean",
              "listsMatchers": {
                "strListsMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "strListsNotMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "regExpListsMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "regExpListsNotMatch": {
                  "listIds": [
                    "string"
                  ]
                }
              }
              // end of the list of possible fields
            }
          ],
          "httpMethodMatcher": {
            // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
            "exactMatch": "string",
            "exactNotMatch": "string",
            "prefixMatch": "string",
            "prefixNotMatch": "string",
            "pireRegexMatch": "string",
            "pireRegexNotMatch": "string",
            "defined": "boolean",
            "listsMatchers": {
              "strListsMatch": {
                "listIds": [
                  "string"
                ]
              },
              "strListsNotMatch": {
                "listIds": [
                  "string"
                ]
              },
              "regExpListsMatch": {
                "listIds": [
                  "string"
                ]
              },
              "regExpListsNotMatch": {
                "listIds": [
                  "string"
                ]
              }
            }
            // end of the list of possible fields
          }
        },
        "requestUri": {
          "path": {
            // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
            "exactMatch": "string",
            "exactNotMatch": "string",
            "prefixMatch": "string",
            "prefixNotMatch": "string",
            "pireRegexMatch": "string",
            "pireRegexNotMatch": "string",
            "defined": "boolean",
            "listsMatchers": {
              "strListsMatch": {
                "listIds": [
                  "string"
                ]
              },
              "strListsNotMatch": {
                "listIds": [
                  "string"
                ]
              },
              "regExpListsMatch": {
                "listIds": [
                  "string"
                ]
              },
              "regExpListsNotMatch": {
                "listIds": [
                  "string"
                ]
              }
            }
            // end of the list of possible fields
          },
          "queries": [
            {
              "key": "string",
              "value": {
                // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                "exactMatch": "string",
                "exactNotMatch": "string",
                "prefixMatch": "string",
                "prefixNotMatch": "string",
                "pireRegexMatch": "string",
                "pireRegexNotMatch": "string",
                "defined": "boolean",
                "listsMatchers": {
                  "strListsMatch": {
                    "listIds": [
                      "string"
                    ]
                  },
                  "strListsNotMatch": {
                    "listIds": [
                      "string"
                    ]
                  },
                  "regExpListsMatch": {
                    "listIds": [
                      "string"
                    ]
                  },
                  "regExpListsNotMatch": {
                    "listIds": [
                      "string"
                    ]
                  }
                }
                // end of the list of possible fields
              }
            }
          ]
        },
        "headers": [
          {
            "name": "string",
            "value": {
              // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
              "exactMatch": "string",
              "exactNotMatch": "string",
              "prefixMatch": "string",
              "prefixNotMatch": "string",
              "pireRegexMatch": "string",
              "pireRegexNotMatch": "string",
              "defined": "boolean",
              "listsMatchers": {
                "strListsMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "strListsNotMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "regExpListsMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "regExpListsNotMatch": {
                  "listIds": [
                    "string"
                  ]
                }
              }
              // end of the list of possible fields
            }
          }
        ],
        "sourceIp": {
          "ipRangesMatch": {
            "ipRanges": [
              "string"
            ]
          },
          "ipRangesNotMatch": {
            "ipRanges": [
              "string"
            ]
          },
          "geoIpMatch": {
            "locations": [
              "string"
            ]
          },
          "geoIpNotMatch": {
            "locations": [
              "string"
            ]
          },
          "ipListsMatch": {
            "listIds": [
              "string"
            ]
          },
          "ipListsNotMatch": {
            "listIds": [
              "string"
            ]
          },
          "asnRangesMatch": {
            "asnRanges": [
              "string"
            ]
          },
          "asnRangesNotMatch": {
            "asnRanges": [
              "string"
            ]
          },
          "asnListsMatch": {
            "listIds": [
              "string"
            ]
          },
          "asnListsNotMatch": {
            "listIds": [
              "string"
            ]
          }
        },
        "cookies": [
          {
            "name": "string",
            "value": {
              // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
              "exactMatch": "string",
              "exactNotMatch": "string",
              "prefixMatch": "string",
              "prefixNotMatch": "string",
              "pireRegexMatch": "string",
              "pireRegexNotMatch": "string",
              "defined": "boolean",
              "listsMatchers": {
                "strListsMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "strListsNotMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "regExpListsMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "regExpListsNotMatch": {
                  "listIds": [
                    "string"
                  ]
                }
              }
              // end of the list of possible fields
            }
          }
        ],
        "botCategory": {
          "botCategoryListsMatch": {
            "listIds": [
              "string"
            ]
          },
          "botCategoryListsNotMatch": {
            "listIds": [
              "string"
            ]
          }
        },
        "botName": {
          "botNameListsMatch": {
            "listIds": [
              "string"
            ]
          },
          "botNameListsNotMatch": {
            "listIds": [
              "string"
            ]
          }
        },
        "botScore": {
          "value": [
            {
              // Includes only one of the fields `leMatch`, `geMatch`, `eqMatch`, `neMatch`
              "leMatch": {
                "value": "string"
              },
              "geMatch": {
                "value": "string"
              },
              "eqMatch": {
                "value": "string"
              },
              "neMatch": {
                "value": "string"
              }
              // end of the list of possible fields
            }
          ]
        },
        "verifiedBot": {
          "verified": {
            "match": "boolean"
          }
        },
        "fingerPrint": {
          "ja3Ranges": [
            {
              // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
              "exactMatch": "string",
              "exactNotMatch": "string",
              "prefixMatch": "string",
              "prefixNotMatch": "string",
              "pireRegexMatch": "string",
              "pireRegexNotMatch": "string",
              "defined": "boolean",
              "listsMatchers": {
                "strListsMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "strListsNotMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "regExpListsMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "regExpListsNotMatch": {
                  "listIds": [
                    "string"
                  ]
                }
              }
              // end of the list of possible fields
            }
          ],
          "ja4Ranges": [
            {
              // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
              "exactMatch": "string",
              "exactNotMatch": "string",
              "prefixMatch": "string",
              "prefixNotMatch": "string",
              "pireRegexMatch": "string",
              "pireRegexNotMatch": "string",
              "defined": "boolean",
              "listsMatchers": {
                "strListsMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "strListsNotMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "regExpListsMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "regExpListsNotMatch": {
                  "listIds": [
                    "string"
                  ]
                }
              }
              // end of the list of possible fields
            }
          ],
          "ja3Matcher": {
            // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
            "exactMatch": "string",
            "exactNotMatch": "string",
            "prefixMatch": "string",
            "prefixNotMatch": "string",
            "pireRegexMatch": "string",
            "pireRegexNotMatch": "string",
            "defined": "boolean",
            "listsMatchers": {
              "strListsMatch": {
                "listIds": [
                  "string"
                ]
              },
              "strListsNotMatch": {
                "listIds": [
                  "string"
                ]
              },
              "regExpListsMatch": {
                "listIds": [
                  "string"
                ]
              },
              "regExpListsNotMatch": {
                "listIds": [
                  "string"
                ]
              }
            }
            // end of the list of possible fields
          },
          "ja4Matcher": {
            // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
            "exactMatch": "string",
            "exactNotMatch": "string",
            "prefixMatch": "string",
            "prefixNotMatch": "string",
            "pireRegexMatch": "string",
            "pireRegexNotMatch": "string",
            "defined": "boolean",
            "listsMatchers": {
              "strListsMatch": {
                "listIds": [
                  "string"
                ]
              },
              "strListsNotMatch": {
                "listIds": [
                  "string"
                ]
              },
              "regExpListsMatch": {
                "listIds": [
                  "string"
                ]
              },
              "regExpListsNotMatch": {
                "listIds": [
                  "string"
                ]
              }
            }
            // end of the list of possible fields
          }
        }
      },
      "excludeRules": {
        "excludeAll": "boolean",
        "ruleIds": [
          "string"
        ]
      },
      "logExcluded": "boolean",
      "requestCondition": {
        "paramMatcher": {
          "paramNames": [
            {
              "value": "string",
              "caseSensitive": "boolean"
            }
          ]
        },
        "headerMatcher": {
          "headerNames": [
            {
              "value": "string",
              "caseSensitive": "boolean"
            }
          ]
        },
        "cookieMatcher": {
          "cookieNames": [
            {
              "value": "string",
              "caseSensitive": "boolean"
            }
          ]
        },
        "bodyMatcher": {
          "bodyValues": [
            {
              "value": "string",
              "caseSensitive": "boolean"
            }
          ]
        }
      }
    }
  ],
  "analyzeRequestBody": {
    "isEnabled": "boolean",
    "sizeLimit": "string",
    "sizeLimitAction": "string"
  },
  "ruleSets": [
    {
      // Includes only one of the fields `coreRuleSet`, `yaRuleSet`, `mlRuleSet`
      "coreRuleSet": {
        "ruleSet": {
          "name": "string",
          "version": "string",
          "type": "string",
          "id": "string"
        },
        "inboundAnomalyScore": "string",
        "paranoiaLevel": "string"
      },
      "yaRuleSet": {
        "ruleSet": {
          "name": "string",
          "version": "string",
          "type": "string",
          "id": "string"
        },
        "ruleGroups": [
          {
            "id": "string",
            "action": "string",
            "inboundAnomalyScore": "string",
            "isEnabled": "boolean"
          }
        ]
      },
      "mlRuleSet": {
        "ruleSet": {
          "name": "string",
          "version": "string",
          "type": "string",
          "id": "string"
        },
        "ruleGroups": [
          {
            "id": "string",
            "action": "string",
            "inboundAnomalyScore": "string",
            "isEnabled": "boolean"
          }
        ]
      },
      // end of the list of possible fields
      "priority": "string",
      "isEnabled": "boolean",
      "action": "string"
    }
  ],
  "matchAllRuleSets": "boolean"
}

Field	Description
coreRuleSet	CoreRuleSet Core rule set settings. See Basic rule set for details. Includes only one of the fields `coreRuleSet`.
updateMask	string (field-mask) A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in `updateMask` and no value for that field was sent in the request, the field's value will be reset to the default. The default value for most fields is null or 0. If `updateMask` is not sent in the request, all fields' values will be updated. Fields specified in the request will be updated to provided values. The rest of the fields will be reset to the default.
name	string Name of the WAF profile. The name is unique within the folder. 1-50 characters long. The string length in characters must be 1-50. Value must match the regular expression `[a-zA-Z0-9][a-zA-Z0-9-_.]*`.
description	string Optional description of the WAF profile.
labels	object (map<string, string>) Labels as `key:value` pairs. Maximum of 64 per resource.
rules[]	WafProfileRule Settings for each rule in rule set.
exclusionRules[]	WafProfileExclusionRule List of exclusion rules. See Rules.
analyzeRequestBody	AnalyzeRequestBody Parameters for request body analyzer.
ruleSets[]	WafProfileRuleSet List of rule sets. See Rules.
matchAllRuleSets	boolean Parameter determines should all rule sets be matched.

CoreRuleSet

Field	Description
inboundAnomalyScore	string (int64) Anomaly score. Enter an integer within the range of 2 and 10000. The higher this value, the more likely it is that the request that satisfies the rule is an attack. See Rules for more details. Acceptable values are 2 to 10000, inclusive.
paranoiaLevel	string (int64) Paranoia level. Enter an integer within the range of 1 and 4. Paranoia level classifies rules according to their aggression. The higher the paranoia level, the better your protection, but also the higher the probability of WAF false positives. See Rules for more details. NOTE: this option has no effect on enabling or disabling rules. it is used only as recommendation for user to enable all rules with paranoia_level <= this value.
ruleSet	RuleSet Required field. Rule set.

RuleSet

A RuleSet object. Determines name and version of rule set.

Field	Description
name	string Required field. Name of rule set.
version	string Required field. Version of rule set.
type	enum (RuleSetType) Type of rule set. `CORE`: Core rule set. `YA`: Yandex rule set. `ML`: Yandex machine learning rule set.
id	string ID of rule set.

WafProfileRule

WafProfileRule object. Determines settings for each rule_id in rule set.

Field	Description
ruleId	string Required field. Rule ID.
isEnabled	boolean Determines is it rule enabled or not.
isBlocking	boolean Determines is it rule blocking or not.

WafProfileExclusionRule

A WafProfileExclusionRule object. See Exclusion rules.

Field	Description
name	string Required field. Name of exclusion rule.
description	string Optional description of the rule. 0-512 characters long. The maximum string length in characters is 512.
condition	Condition The condition for matching traffic.
excludeRules	ExcludeRules Required field. Exclude rules.
logExcluded	boolean Records the fact that an exception rule is triggered.
requestCondition	RequestCondition Additional condition applied to specific parts of the request to refine when the exclusion is triggered.

Condition

Condition object. AND semantics implied.
See documentation for matchers description.

Field	Description
authority	AuthorityMatcher Match authority (Host header).
httpMethod	HttpMethodMatcher Match HTTP method.
requestUri	RequestUriMatcher Match Request URI.
headers[]	HeaderMatcher Match HTTP headers. The maximum number of elements is 20.
sourceIp	IpMatcher Match IP.
cookies[]	CookieMatcher Match cookies. The maximum number of elements is 20.
botCategory	BotCategoryMatcher Match bot category.
botName	BotNameMatcher Match bot name.
botScore	BotScoreMatcher Match bot score.
verifiedBot	VerifiedBotMatcher Match verified bot.
fingerPrint	FingerPrintMatcher Match fingerprint.

AuthorityMatcher

AuthorityMatcher object.

Field

Description

authorities[]

StringMatcher

List of authorities. OR semantics implied.

The maximum number of elements is 20.

authorityMatcher

StringMatcher

Authority matcher.

StringMatcher

StringMatcher object.

Field	Description
exactMatch	string Exact match condition. The string length in characters must be 0-255. Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`.
exactNotMatch	string Exact not match condition. The string length in characters must be 0-255. Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`.
prefixMatch	string Prefix match condition. The string length in characters must be 0-255. Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`.
prefixNotMatch	string Prefix not match condition. The string length in characters must be 0-255. Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`.
pireRegexMatch	string PIRE regex match condition. The string length in characters must be 0-255. Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`.
pireRegexNotMatch	string PIRE regex not match condition. The string length in characters must be 0-255. Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`.
defined	boolean Matches if the field is defined. Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`.
listsMatchers	ListsMatchers Matches against string and regular expression lists. Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`.

ListsMatchers

ListsMatchers object.

Field	Description
strListsMatch	ListsMatcher String lists to match with.
strListsNotMatch	ListsMatcher String lists to not match with.
regExpListsMatch	ListsMatcher Regular expression lists to match with.
regExpListsNotMatch	ListsMatcher Regular expression lists to not match with.

ListsMatcher

ListsMatcher object.

Field

Description

listIds[]

string

List of list IDs to match against. OR semantics implied.

The number of elements must be in the range 1-10.

HttpMethodMatcher

HttpMethodMatcher object.

Field

Description

httpMethods[]

StringMatcher

List of HTTP methods. OR semantics implied.

The maximum number of elements is 20.

httpMethodMatcher

StringMatcher

HTTP method matcher.

RequestUriMatcher

RequestUriMatcher object. AND semantics implied.

Field

Description

path

StringMatcher

Path of the URI RFC3986.

queries[]

QueryMatcher

List of query matchers. AND semantics implied.

The maximum number of elements is 20.

QueryMatcher

QueryMatcher object.

Field

Description

key

string

Required field. Key of the query parameter.

The string length in characters must be 1-255.

value

StringMatcher

Required field. Value of the query parameter.

HeaderMatcher

HeaderMatcher object.

Field

Description

name

string

Required field. Name of header (case insensitive).

The string length in characters must be 1-255.

value

StringMatcher

Required field. Value of the header.

IpMatcher

IpMatcher object. AND semantics implied.

Field	Description
ipRangesMatch	IpRangesMatcher IP ranges to match with.
ipRangesNotMatch	IpRangesMatcher IP ranges to not match with.
geoIpMatch	GeoIpMatcher Geo locations to match with.
geoIpNotMatch	GeoIpMatcher Geo locations to not match with.
ipListsMatch	ListsMatcher IP lists to match with.
ipListsNotMatch	ListsMatcher IP lists to not match with.
asnRangesMatch	AsnRangesMatcher ASN ranges to match with.
asnRangesNotMatch	AsnRangesMatcher ASN ranges to not match with.
asnListsMatch	ListsMatcher ASN lists to match with.
asnListsNotMatch	ListsMatcher ASN lists to not match with.

IpRangesMatcher

IpRangesMatcher object.

Field

Description

ipRanges[]

string

List of IP ranges. OR semantics implied.

The string length in characters for each value must be greater than 0. The maximum number of elements is 10000.

GeoIpMatcher

GeoIpMatcher object.

Field

Description

locations[]

string

ISO 3166-1 alpha 2. OR semantics implied.

The minimum number of elements is 1.

AsnRangesMatcher

AsnRangesMatcher object.

Field

Description

asnRanges[]

string (int64)

List of ASN values to match against. OR semantics implied.

The maximum number of elements is 10000. Acceptable values are 0 to 4294967295, inclusive.

CookieMatcher

CookieMatcher object.

Field

Description

name

string

Required field. Name of the cookie parametr.

The string length in characters must be 1-255.

value

StringMatcher

Required field. Value of the cookie parametr.

BotCategoryMatcher

BotCategoryMatcher object. AND semantics implied.

Field

Description

botCategoryListsMatch

ListsMatcher

Bot category lists to match with.

botCategoryListsNotMatch

ListsMatcher

Bot category lists to not match with.

BotNameMatcher

BotNameMatcher object. AND semantics implied.

Field

Description

botNameListsMatch

ListsMatcher

Bot name lists to match with.

botNameListsNotMatch

ListsMatcher

Bot name lists to not match with.

BotScoreMatcher

BotScoreMatcher object.

Field

Description

value[]

IntMatcher

List of integer matchers for bot score. OR semantics implied.

The maximum number of elements is 4.

IntMatcher

IntMatcher object.

Field	Description
leMatch	IntLEMatcher Less than or equal condition. Includes only one of the fields `leMatch`, `geMatch`, `eqMatch`, `neMatch`.
geMatch	IntGEMatcher Greater than or equal condition. Includes only one of the fields `leMatch`, `geMatch`, `eqMatch`, `neMatch`.
eqMatch	IntEQMatcher Equal condition. Includes only one of the fields `leMatch`, `geMatch`, `eqMatch`, `neMatch`.
neMatch	IntNEMatcher Not equal condition. Includes only one of the fields `leMatch`, `geMatch`, `eqMatch`, `neMatch`.

IntLEMatcher

IntLEMatcher object.

Field

Description

value

string (int64)

Upper bound value (inclusive).

IntGEMatcher

IntGEMatcher object.

Field

Description

value

string (int64)

Lower bound value (inclusive).

IntEQMatcher

IntEQMatcher object.

Field

Description

value

string (int64)

Value to match against.

IntNEMatcher

IntNEMatcher object.

Field

Description

value

string (int64)

Value to not match against.

VerifiedBotMatcher

VerifiedBotMatcher object.

Field

Description

verified

BoolMatcher

Matches if the bot is verified or not.

BoolMatcher

BoolMatcher object.

Field

Description

match

boolean

Boolean value to match against.

FingerPrintMatcher

FingerPrintMatcher object.

Field	Description
ja3Ranges[]	StringMatcher List of JA3 fingerprint matchers. OR semantics implied. The maximum number of elements is 20.
ja4Ranges[]	StringMatcher List of JA4 fingerprint matchers. OR semantics implied. The maximum number of elements is 20.
ja3Matcher	StringMatcher JA3 fingerprint matcher.
ja4Matcher	StringMatcher JA4 fingerprint matcher.

ExcludeRules

Determines list of excluded rules.

Field

Description

excludeAll

boolean

Set this option true to exclude all rules.

ruleIds[]

string

List of rules to exclude.

RequestCondition

Field	Description
paramMatcher	RequestParamMatcher Matcher for request query parameters.
headerMatcher	HeaderMatcher Matcher for request headers.
cookieMatcher	CookieMatcher Matcher for request cookies.
bodyMatcher	BodyMatcher Matcher for request body.

RequestParamMatcher

Field

Description

paramNames[]

StringMatcher

List of request query parameter names to match. Up to 20 entries.

The maximum number of elements is 20.

StringMatcher

Field

Description

value

string

String value to match against.

caseSensitive

boolean

Whether the match is case sensitive.

HeaderMatcher

Field

Description

headerNames[]

StringMatcher

List of request header names to match. Up to 20 entries.

The maximum number of elements is 20.

CookieMatcher

Field

Description

cookieNames[]

StringMatcher

List of cookie names to match. Up to 20 entries.

The maximum number of elements is 20.

BodyMatcher

Field

Description

bodyValues[]

StringMatcher

List of request body values to match. Up to 20 entries.

The maximum number of elements is 20.

AnalyzeRequestBody

Field	Description
isEnabled	boolean Possible to turn analyzer on and turn if off.
sizeLimit	string (int64) Maximum size of body to pass to analyzer. In kilobytes.
sizeLimitAction	enum (Action) Action to perform if maximum size of body exceeded. `IGNORE`: Ignore request. `DENY`: Deny request.

WafProfileRuleSet

Field	Description
coreRuleSet	WafProfileCoreRuleSet Core rule set settings. See Basic rule set for details. Includes only one of the fields `coreRuleSet`, `yaRuleSet`, `mlRuleSet`.
yaRuleSet	WafProfileYaRuleSet Yandex rule set settings. Includes only one of the fields `coreRuleSet`, `yaRuleSet`, `mlRuleSet`.
mlRuleSet	WafProfileMlRuleSet Yandex Machine learning rule set settings. Includes only one of the fields `coreRuleSet`, `yaRuleSet`, `mlRuleSet`.
priority	string (int64) Priority of rule set. Acceptable values are 1 to 999999, inclusive.
isEnabled	boolean Determines is it rule set enabled or not.
action	enum (RuleSetAction) Action to perfome on rule set match. `DENY`: Deny request. `CAPTCHA`: Show captcha.

WafProfileCoreRuleSet

Field	Description
ruleSet	RuleSet Required field. Rule set.
inboundAnomalyScore	string (int64) Anomaly score. Enter an integer within the range of 2 and 10000. The higher this value, the more likely it is that the request that satisfies the rule is an attack. See Rules for more details. Acceptable values are 2 to 10000, inclusive.
paranoiaLevel	string (int64) Paranoia level. Enter an integer within the range of 1 and 4. Paranoia level classifies rules according to their aggression. The higher the paranoia level, the better your protection, but also the higher the probability of WAF false positives. See Rules for more details. NOTE: this option has no effect on enabling or disabling rules. it is used only as recommendation for user to enable all rules with paranoia_level <= this value.

WafProfileYaRuleSet

Field

Description

ruleSet

RuleSet

Required field. Rule set.

ruleGroups[]

RuleGroup

List of rule groups.

RuleGroup

Field	Description
id	string ID of the rule group.
action	enum (Action) Action to perfome on rule group match. `DENY`: Deny request. `LOG`: Log request. `IGNORE`: Ignore request.
inboundAnomalyScore	string (int64) Anomaly score. Acceptable values are 1 to 10000, inclusive.
isEnabled	boolean Determines is it rule group enabled or not.

WafProfileMlRuleSet

Field

Description

ruleSet

RuleSet

Required field. Rule set.

ruleGroups[]

RuleGroup

List of rule groups.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": "object",
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object"
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
done	boolean If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	object Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	object The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

Status

The error result of the operation in case of failure or cancellation.

Field	Description
code	integer (int32) Error code. An enum value of google.rpc.Code.
message	string An error message.
details[]	object A list of messages that carry the error details.

SmartWebSecurity WAF API, REST: WafProfile.Update

HTTP requestHTTP request

Path parametersPath parameters

Body parametersBody parameters

CoreRuleSetCoreRuleSet

RuleSetRuleSet

WafProfileRuleWafProfileRule

WafProfileExclusionRuleWafProfileExclusionRule

ConditionCondition

AuthorityMatcherAuthorityMatcher

StringMatcherStringMatcher

ListsMatchersListsMatchers

ListsMatcherListsMatcher

HttpMethodMatcherHttpMethodMatcher

RequestUriMatcherRequestUriMatcher

QueryMatcherQueryMatcher

HeaderMatcherHeaderMatcher

IpMatcherIpMatcher

IpRangesMatcherIpRangesMatcher

GeoIpMatcherGeoIpMatcher

AsnRangesMatcherAsnRangesMatcher

CookieMatcherCookieMatcher

BotCategoryMatcherBotCategoryMatcher

BotNameMatcherBotNameMatcher

BotScoreMatcherBotScoreMatcher

IntMatcherIntMatcher

IntLEMatcherIntLEMatcher

IntGEMatcherIntGEMatcher

IntEQMatcherIntEQMatcher

IntNEMatcherIntNEMatcher

VerifiedBotMatcherVerifiedBotMatcher

BoolMatcherBoolMatcher

FingerPrintMatcherFingerPrintMatcher

ExcludeRulesExcludeRules

RequestConditionRequestCondition

RequestParamMatcherRequestParamMatcher

StringMatcherStringMatcher

HeaderMatcherHeaderMatcher

CookieMatcherCookieMatcher

BodyMatcherBodyMatcher

AnalyzeRequestBodyAnalyzeRequestBody

WafProfileRuleSetWafProfileRuleSet

WafProfileCoreRuleSetWafProfileCoreRuleSet

WafProfileYaRuleSetWafProfileYaRuleSet

RuleGroupRuleGroup

WafProfileMlRuleSetWafProfileMlRuleSet

ResponseResponse

StatusStatus

Была ли статья полезна?

HTTP request

Path parameters

Body parameters

CoreRuleSet

RuleSet

WafProfileRule

WafProfileExclusionRule

Condition

AuthorityMatcher

StringMatcher

ListsMatchers

ListsMatcher

HttpMethodMatcher

RequestUriMatcher

QueryMatcher

HeaderMatcher

IpMatcher

IpRangesMatcher

GeoIpMatcher

AsnRangesMatcher

CookieMatcher

BotCategoryMatcher

BotNameMatcher

BotScoreMatcher

IntMatcher

IntLEMatcher

IntGEMatcher

IntEQMatcher

IntNEMatcher

VerifiedBotMatcher

BoolMatcher

FingerPrintMatcher

ExcludeRules

RequestCondition

RequestParamMatcher

StringMatcher

HeaderMatcher

CookieMatcher

BodyMatcher

AnalyzeRequestBody

WafProfileRuleSet

WafProfileCoreRuleSet

WafProfileYaRuleSet

RuleGroup

WafProfileMlRuleSet

Response

Status