[Yandex Cloud documentation](../../../../index.md) > [Yandex Smart Web Security](../../../index.md) > API reference > REST > [SmartWebSecurity ARL API](../index.md) > [AdvancedRateLimiterProfile](index.md) > Update # SmartWebSecurity ARL API, REST: AdvancedRateLimiterProfile.Update Updates the specified ARL profile. ## HTTP request ``` PATCH https://smartwebsecurity.api.cloud.yandex.net/smartwebsecurity/v1/advancedRateLimiterProfiles/{advancedRateLimiterProfileId} ``` ## Path parameters #| ||Field | Description || || advancedRateLimiterProfileId | **string** Required field. ID of the ARL profile to update. || |# ## Body parameters {#yandex.cloud.smartwebsecurity.v1.advanced_rate_limiter.UpdateAdvancedRateLimiterProfileRequest} ```json { "updateMask": "string", "labels": "object", "name": "string", "description": "string", "advancedRateLimiterRules": [ { // Includes only one of the fields `staticQuota`, `dynamicQuota` "staticQuota": { "action": "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 } } }, "limit": "string", "period": "string" }, "dynamicQuota": { "action": "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 } } }, "limit": "string", "period": "string", "characteristics": [ { // Includes only one of the fields `simpleCharacteristic`, `keyCharacteristic` "simpleCharacteristic": { "type": "string" }, "keyCharacteristic": { "type": "string", "value": "string" }, // end of the list of possible fields "caseInsensitive": "boolean" } ] }, // end of the list of possible fields "name": "string", "priority": "string", "description": "string", "dryRun": "boolean" } ] } ``` #| ||Field | Description || || 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. || || labels | **object** (map<**string**, **string**>) Labels as `` key:value `` pairs. Maximum of 64 per resource. || || name | **string** Name of the ARL 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 ARL profile. || || advancedRateLimiterRules[] | **[AdvancedRateLimiterRule](#yandex.cloud.smartwebsecurity.v1.advanced_rate_limiter.AdvancedRateLimiterRule)** List of rules. || |# ## AdvancedRateLimiterRule {#yandex.cloud.smartwebsecurity.v1.advanced_rate_limiter.AdvancedRateLimiterRule} A AdvancedRateLimiterRule object, see [Rules](../../../concepts/arl.md#traffic-conditions). #| ||Field | Description || || staticQuota | **[StaticQuota](#yandex.cloud.smartwebsecurity.v1.advanced_rate_limiter.AdvancedRateLimiterRule.StaticQuota)** Static quota. Counting each request individually. Includes only one of the fields `staticQuota`, `dynamicQuota`. || || dynamicQuota | **[DynamicQuota](#yandex.cloud.smartwebsecurity.v1.advanced_rate_limiter.AdvancedRateLimiterRule.DynamicQuota)** Dynamic quota. Grouping requests by a certain attribute and limiting the number of groups. Includes only one of the fields `staticQuota`, `dynamicQuota`. || || name | **string** Required field. Name of the rule. The name is unique within the ARL profile. 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-_.]* `. || || priority | **string** (int64) Determines the priority in case there are several matched rules. Enter an integer within the range of 1 and 999999. The rule priority must be unique within the entire ARL profile. A lower numeric value means a higher priority. Acceptable values are 1 to 999999, inclusive. || || description | **string** Optional description of the rule. 0-512 characters long. The maximum string length in characters is 512. || || dryRun | **boolean** This allows you to evaluate backend capabilities and find the optimum limit values. Requests will not be blocked in this mode. || |# ## StaticQuota {#yandex.cloud.smartwebsecurity.v1.advanced_rate_limiter.AdvancedRateLimiterRule.StaticQuota} StaticQuota object. #| ||Field | Description || || action | **enum** (Action) Required field. Action in case of exceeding this quota. - `DENY`: Deny request. || || condition | **[Condition](#yandex.cloud.smartwebsecurity.v1.Condition)** The condition for matching the quota. || || limit | **string** (int64) Desired maximum number of requests per period. Enter an integer within the range of 1 and 9999999999999. Acceptable values are 1 to 9999999999999, inclusive. || || period | **string** (int64) Period of time in seconds. || |# ## Condition {#yandex.cloud.smartwebsecurity.v1.Condition} Condition object. AND semantics implied. See [documentation](../../../concepts/conditions.md) for matchers description. #| ||Field | Description || || authority | **[AuthorityMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.AuthorityMatcher)** Match authority (Host header). || || httpMethod | **[HttpMethodMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.HttpMethodMatcher)** Match HTTP method. || || requestUri | **[RequestUriMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.RequestUriMatcher)** Match Request URI. || || headers[] | **[HeaderMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.HeaderMatcher)** Match HTTP headers. The maximum number of elements is 20. || || sourceIp | **[IpMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.IpMatcher)** Match IP. || || cookies[] | **[CookieMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.CookieMatcher)** Match cookies. The maximum number of elements is 20. || || botCategory | **[BotCategoryMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.BotCategoryMatcher)** Match bot category. || || botName | **[BotNameMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.BotNameMatcher)** Match bot name. || || botScore | **[BotScoreMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.BotScoreMatcher)** Match bot score. || || verifiedBot | **[VerifiedBotMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.VerifiedBotMatcher)** Match verified bot. || || fingerPrint | **[FingerPrintMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.FingerPrintMatcher)** Match fingerprint. || |# ## AuthorityMatcher {#yandex.cloud.smartwebsecurity.v1.Condition.AuthorityMatcher} AuthorityMatcher object. #| ||Field | Description || || authorities[] | **[StringMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.StringMatcher)** List of authorities. OR semantics implied. The maximum number of elements is 20. || || authorityMatcher | **[StringMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.StringMatcher)** Authority matcher. || |# ## StringMatcher {#yandex.cloud.smartwebsecurity.v1.Condition.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](#yandex.cloud.smartwebsecurity.v1.Condition.ListsMatchers)** Matches against string and regular expression lists. Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`. || |# ## ListsMatchers {#yandex.cloud.smartwebsecurity.v1.Condition.ListsMatchers} ListsMatchers object. #| ||Field | Description || || strListsMatch | **[ListsMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.ListsMatcher)** String lists to match with. || || strListsNotMatch | **[ListsMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.ListsMatcher)** String lists to not match with. || || regExpListsMatch | **[ListsMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.ListsMatcher)** Regular expression lists to match with. || || regExpListsNotMatch | **[ListsMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.ListsMatcher)** Regular expression lists to not match with. || |# ## ListsMatcher {#yandex.cloud.smartwebsecurity.v1.Condition.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 {#yandex.cloud.smartwebsecurity.v1.Condition.HttpMethodMatcher} HttpMethodMatcher object. #| ||Field | Description || || httpMethods[] | **[StringMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.StringMatcher)** List of HTTP methods. OR semantics implied. The maximum number of elements is 20. || || httpMethodMatcher | **[StringMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.StringMatcher)** HTTP method matcher. || |# ## RequestUriMatcher {#yandex.cloud.smartwebsecurity.v1.Condition.RequestUriMatcher} RequestUriMatcher object. AND semantics implied. #| ||Field | Description || || path | **[StringMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.StringMatcher)** Path of the URI [RFC3986](https://datatracker.ietf.org/doc/html/rfc3986#section-3.3). || || queries[] | **[QueryMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.QueryMatcher)** List of query matchers. AND semantics implied. The maximum number of elements is 20. || |# ## QueryMatcher {#yandex.cloud.smartwebsecurity.v1.Condition.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](#yandex.cloud.smartwebsecurity.v1.Condition.StringMatcher)** Required field. Value of the query parameter. || |# ## HeaderMatcher {#yandex.cloud.smartwebsecurity.v1.Condition.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](#yandex.cloud.smartwebsecurity.v1.Condition.StringMatcher)** Required field. Value of the header. || |# ## IpMatcher {#yandex.cloud.smartwebsecurity.v1.Condition.IpMatcher} IpMatcher object. AND semantics implied. #| ||Field | Description || || ipRangesMatch | **[IpRangesMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.IpRangesMatcher)** IP ranges to match with. || || ipRangesNotMatch | **[IpRangesMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.IpRangesMatcher)** IP ranges to not match with. || || geoIpMatch | **[GeoIpMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.GeoIpMatcher)** Geo locations to match with. || || geoIpNotMatch | **[GeoIpMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.GeoIpMatcher)** Geo locations to not match with. || || ipListsMatch | **[ListsMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.ListsMatcher)** IP lists to match with. || || ipListsNotMatch | **[ListsMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.ListsMatcher)** IP lists to not match with. || || asnRangesMatch | **[AsnRangesMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.AsnRangesMatcher)** ASN ranges to match with. || || asnRangesNotMatch | **[AsnRangesMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.AsnRangesMatcher)** ASN ranges to not match with. || || asnListsMatch | **[ListsMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.ListsMatcher)** ASN lists to match with. || || asnListsNotMatch | **[ListsMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.ListsMatcher)** ASN lists to not match with. || |# ## IpRangesMatcher {#yandex.cloud.smartwebsecurity.v1.Condition.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 {#yandex.cloud.smartwebsecurity.v1.Condition.GeoIpMatcher} GeoIpMatcher object. #| ||Field | Description || || locations[] | **string** ISO 3166-1 alpha 2. OR semantics implied. The minimum number of elements is 1. || |# ## AsnRangesMatcher {#yandex.cloud.smartwebsecurity.v1.Condition.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 {#yandex.cloud.smartwebsecurity.v1.Condition.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](#yandex.cloud.smartwebsecurity.v1.Condition.StringMatcher)** Required field. Value of the cookie parametr. || |# ## BotCategoryMatcher {#yandex.cloud.smartwebsecurity.v1.Condition.BotCategoryMatcher} BotCategoryMatcher object. AND semantics implied. #| ||Field | Description || || botCategoryListsMatch | **[ListsMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.ListsMatcher)** Bot category lists to match with. || || botCategoryListsNotMatch | **[ListsMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.ListsMatcher)** Bot category lists to not match with. || |# ## BotNameMatcher {#yandex.cloud.smartwebsecurity.v1.Condition.BotNameMatcher} BotNameMatcher object. AND semantics implied. #| ||Field | Description || || botNameListsMatch | **[ListsMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.ListsMatcher)** Bot name lists to match with. || || botNameListsNotMatch | **[ListsMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.ListsMatcher)** Bot name lists to not match with. || |# ## BotScoreMatcher {#yandex.cloud.smartwebsecurity.v1.Condition.BotScoreMatcher} BotScoreMatcher object. #| ||Field | Description || || value[] | **[IntMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.IntMatcher)** List of integer matchers for bot score. OR semantics implied. The maximum number of elements is 4. || |# ## IntMatcher {#yandex.cloud.smartwebsecurity.v1.Condition.IntMatcher} IntMatcher object. #| ||Field | Description || || leMatch | **[IntLEMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.IntLEMatcher)** Less than or equal condition. Includes only one of the fields `leMatch`, `geMatch`, `eqMatch`, `neMatch`. || || geMatch | **[IntGEMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.IntGEMatcher)** Greater than or equal condition. Includes only one of the fields `leMatch`, `geMatch`, `eqMatch`, `neMatch`. || || eqMatch | **[IntEQMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.IntEQMatcher)** Equal condition. Includes only one of the fields `leMatch`, `geMatch`, `eqMatch`, `neMatch`. || || neMatch | **[IntNEMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.IntNEMatcher)** Not equal condition. Includes only one of the fields `leMatch`, `geMatch`, `eqMatch`, `neMatch`. || |# ## IntLEMatcher {#yandex.cloud.smartwebsecurity.v1.Condition.IntLEMatcher} IntLEMatcher object. #| ||Field | Description || || value | **string** (int64) Upper bound value (inclusive). || |# ## IntGEMatcher {#yandex.cloud.smartwebsecurity.v1.Condition.IntGEMatcher} IntGEMatcher object. #| ||Field | Description || || value | **string** (int64) Lower bound value (inclusive). || |# ## IntEQMatcher {#yandex.cloud.smartwebsecurity.v1.Condition.IntEQMatcher} IntEQMatcher object. #| ||Field | Description || || value | **string** (int64) Value to match against. || |# ## IntNEMatcher {#yandex.cloud.smartwebsecurity.v1.Condition.IntNEMatcher} IntNEMatcher object. #| ||Field | Description || || value | **string** (int64) Value to not match against. || |# ## VerifiedBotMatcher {#yandex.cloud.smartwebsecurity.v1.Condition.VerifiedBotMatcher} VerifiedBotMatcher object. #| ||Field | Description || || verified | **[BoolMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.BoolMatcher)** Matches if the bot is verified or not. || |# ## BoolMatcher {#yandex.cloud.smartwebsecurity.v1.Condition.BoolMatcher} BoolMatcher object. #| ||Field | Description || || match | **boolean** Boolean value to match against. || |# ## FingerPrintMatcher {#yandex.cloud.smartwebsecurity.v1.Condition.FingerPrintMatcher} FingerPrintMatcher object. #| ||Field | Description || || ja3Ranges[] | **[StringMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.StringMatcher)** List of JA3 fingerprint matchers. OR semantics implied. The maximum number of elements is 20. || || ja4Ranges[] | **[StringMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.StringMatcher)** List of JA4 fingerprint matchers. OR semantics implied. The maximum number of elements is 20. || || ja3Matcher | **[StringMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.StringMatcher)** JA3 fingerprint matcher. || || ja4Matcher | **[StringMatcher](#yandex.cloud.smartwebsecurity.v1.Condition.StringMatcher)** JA4 fingerprint matcher. || |# ## DynamicQuota {#yandex.cloud.smartwebsecurity.v1.advanced_rate_limiter.AdvancedRateLimiterRule.DynamicQuota} DynamicQuota object. #| ||Field | Description || || action | **enum** (Action) Required field. Action in case of exceeding this quota. - `DENY`: Deny request. || || condition | **[Condition](#yandex.cloud.smartwebsecurity.v1.Condition)** The condition for matching the quota. || || limit | **string** (int64) Desired maximum number of requests per period. Enter an integer within the range of 1 and 9999999999999. Acceptable values are 1 to 9999999999999, inclusive. || || period | **string** (int64) Period of time in seconds. || || characteristics[] | **[Characteristic](#yandex.cloud.smartwebsecurity.v1.advanced_rate_limiter.AdvancedRateLimiterRule.DynamicQuota.Characteristic)** List of characteristics. The maximum number of elements is 3. || |# ## Characteristic {#yandex.cloud.smartwebsecurity.v1.advanced_rate_limiter.AdvancedRateLimiterRule.DynamicQuota.Characteristic} #| ||Field | Description || || simpleCharacteristic | **[SimpleCharacteristic](#yandex.cloud.smartwebsecurity.v1.advanced_rate_limiter.AdvancedRateLimiterRule.DynamicQuota.Characteristic.SimpleCharacteristic)** Characteristic automatically based on the Request path, HTTP method, IP address, Region, and Host attributes. See [Rules](../../../concepts/arl.md#requests-counting) for more details. Includes only one of the fields `simpleCharacteristic`, `keyCharacteristic`. || || keyCharacteristic | **[KeyCharacteristic](#yandex.cloud.smartwebsecurity.v1.advanced_rate_limiter.AdvancedRateLimiterRule.DynamicQuota.Characteristic.KeyCharacteristic)** Characteristic based on key match in the Query params, HTTP header, and HTTP cookie attributes. See [Rules](../../../concepts/arl.md#requests-counting) for more details. Includes only one of the fields `simpleCharacteristic`, `keyCharacteristic`. || || caseInsensitive | **boolean** Determines case-sensitive or case-insensitive keys matching. || |# ## SimpleCharacteristic {#yandex.cloud.smartwebsecurity.v1.advanced_rate_limiter.AdvancedRateLimiterRule.DynamicQuota.Characteristic.SimpleCharacteristic} #| ||Field | Description || || type | **enum** (Type) Type of simple characteristic. - `REQUEST_PATH`: HTTP Request path. - `HTTP_METHOD`: HTTP Method. - `IP`: IP address. - `GEO`: Region. - `HOST`: Host. || |# ## KeyCharacteristic {#yandex.cloud.smartwebsecurity.v1.advanced_rate_limiter.AdvancedRateLimiterRule.DynamicQuota.Characteristic.KeyCharacteristic} #| ||Field | Description || || type | **enum** (Type) Type of key characteristic. - `COOKIE_KEY`: HTTP cookie key. - `HEADER_KEY`: HTTP header key. - `QUERY_KEY`: Query params key. || || value | **string** String value of the key. || |# ## Response {#yandex.cloud.operation.Operation} **HTTP Code: 200 - OK** ```json { "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](../../../../api-design-guide/concepts/operation.md). #| ||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](https://www.ietf.org/rfc/rfc3339.txt) 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](https://developers.google.com/protocol-buffers/docs/reference/overview). 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](https://www.ietf.org/rfc/rfc3339.txt) 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](https://developers.google.com/protocol-buffers/docs/reference/overview). 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](#google.rpc.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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#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 {#google.rpc.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](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || || message | **string** An error message. || || details[] | **object** A list of messages that carry the error details. || |#