SmartWebSecurity ARL API, gRPC: AdvancedRateLimiterProfileService.List
- gRPC request
- ListAdvancedRateLimiterProfilesRequest
- ListAdvancedRateLimiterProfilesResponse
- AdvancedRateLimiterProfile
- AdvancedRateLimiterRule
- StaticQuota
- 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
- DynamicQuota
- Characteristic
- SimpleCharacteristic
- KeyCharacteristic
Retrieves the list of AdvancedRateLimiterProfile resources in the specified folder.
gRPC request
rpc List (ListAdvancedRateLimiterProfilesRequest) returns (ListAdvancedRateLimiterProfilesResponse)
ListAdvancedRateLimiterProfilesRequest
{
"folder_id": "string"
}
|
Field |
Description |
|
folder_id |
string Required field. ID of the folder that the ARL profile belongs to. |
ListAdvancedRateLimiterProfilesResponse
{
"advanced_rate_limiter_profiles": [
{
"id": "string",
"folder_id": "string",
"labels": "map<string, string>",
"name": "string",
"description": "string",
"advanced_rate_limiter_rules": [
{
// Includes only one of the fields `static_quota`, `dynamic_quota`
"static_quota": {
"action": "Action",
"condition": {
"authority": {
"authorities": [
{
// Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`, `defined`, `lists_matchers`
"exact_match": "string",
"exact_not_match": "string",
"prefix_match": "string",
"prefix_not_match": "string",
"pire_regex_match": "string",
"pire_regex_not_match": "string",
"defined": "bool",
"lists_matchers": {
"str_lists_match": {
"list_ids": [
"string"
]
},
"str_lists_not_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_not_match": {
"list_ids": [
"string"
]
}
}
// end of the list of possible fields
}
],
"authority_matcher": {
// Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`, `defined`, `lists_matchers`
"exact_match": "string",
"exact_not_match": "string",
"prefix_match": "string",
"prefix_not_match": "string",
"pire_regex_match": "string",
"pire_regex_not_match": "string",
"defined": "bool",
"lists_matchers": {
"str_lists_match": {
"list_ids": [
"string"
]
},
"str_lists_not_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_not_match": {
"list_ids": [
"string"
]
}
}
// end of the list of possible fields
}
},
"http_method": {
"http_methods": [
{
// Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`, `defined`, `lists_matchers`
"exact_match": "string",
"exact_not_match": "string",
"prefix_match": "string",
"prefix_not_match": "string",
"pire_regex_match": "string",
"pire_regex_not_match": "string",
"defined": "bool",
"lists_matchers": {
"str_lists_match": {
"list_ids": [
"string"
]
},
"str_lists_not_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_not_match": {
"list_ids": [
"string"
]
}
}
// end of the list of possible fields
}
],
"http_method_matcher": {
// Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`, `defined`, `lists_matchers`
"exact_match": "string",
"exact_not_match": "string",
"prefix_match": "string",
"prefix_not_match": "string",
"pire_regex_match": "string",
"pire_regex_not_match": "string",
"defined": "bool",
"lists_matchers": {
"str_lists_match": {
"list_ids": [
"string"
]
},
"str_lists_not_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_not_match": {
"list_ids": [
"string"
]
}
}
// end of the list of possible fields
}
},
"request_uri": {
"path": {
// Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`, `defined`, `lists_matchers`
"exact_match": "string",
"exact_not_match": "string",
"prefix_match": "string",
"prefix_not_match": "string",
"pire_regex_match": "string",
"pire_regex_not_match": "string",
"defined": "bool",
"lists_matchers": {
"str_lists_match": {
"list_ids": [
"string"
]
},
"str_lists_not_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_not_match": {
"list_ids": [
"string"
]
}
}
// end of the list of possible fields
},
"queries": [
{
"key": "string",
"value": {
// Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`, `defined`, `lists_matchers`
"exact_match": "string",
"exact_not_match": "string",
"prefix_match": "string",
"prefix_not_match": "string",
"pire_regex_match": "string",
"pire_regex_not_match": "string",
"defined": "bool",
"lists_matchers": {
"str_lists_match": {
"list_ids": [
"string"
]
},
"str_lists_not_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_not_match": {
"list_ids": [
"string"
]
}
}
// end of the list of possible fields
}
}
]
},
"headers": [
{
"name": "string",
"value": {
// Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`, `defined`, `lists_matchers`
"exact_match": "string",
"exact_not_match": "string",
"prefix_match": "string",
"prefix_not_match": "string",
"pire_regex_match": "string",
"pire_regex_not_match": "string",
"defined": "bool",
"lists_matchers": {
"str_lists_match": {
"list_ids": [
"string"
]
},
"str_lists_not_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_not_match": {
"list_ids": [
"string"
]
}
}
// end of the list of possible fields
}
}
],
"source_ip": {
"ip_ranges_match": {
"ip_ranges": [
"string"
]
},
"ip_ranges_not_match": {
"ip_ranges": [
"string"
]
},
"geo_ip_match": {
"locations": [
"string"
]
},
"geo_ip_not_match": {
"locations": [
"string"
]
},
"ip_lists_match": {
"list_ids": [
"string"
]
},
"ip_lists_not_match": {
"list_ids": [
"string"
]
},
"asn_ranges_match": {
"asn_ranges": [
"int64"
]
},
"asn_ranges_not_match": {
"asn_ranges": [
"int64"
]
},
"asn_lists_match": {
"list_ids": [
"string"
]
},
"asn_lists_not_match": {
"list_ids": [
"string"
]
}
},
"cookies": [
{
"name": "string",
"value": {
// Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`, `defined`, `lists_matchers`
"exact_match": "string",
"exact_not_match": "string",
"prefix_match": "string",
"prefix_not_match": "string",
"pire_regex_match": "string",
"pire_regex_not_match": "string",
"defined": "bool",
"lists_matchers": {
"str_lists_match": {
"list_ids": [
"string"
]
},
"str_lists_not_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_not_match": {
"list_ids": [
"string"
]
}
}
// end of the list of possible fields
}
}
],
"bot_category": {
"bot_category_lists_match": {
"list_ids": [
"string"
]
},
"bot_category_lists_not_match": {
"list_ids": [
"string"
]
}
},
"bot_name": {
"bot_name_lists_match": {
"list_ids": [
"string"
]
},
"bot_name_lists_not_match": {
"list_ids": [
"string"
]
}
},
"bot_score": {
"value": [
{
// Includes only one of the fields `le_match`, `ge_match`, `eq_match`, `ne_match`
"le_match": {
"value": "int64"
},
"ge_match": {
"value": "int64"
},
"eq_match": {
"value": "int64"
},
"ne_match": {
"value": "int64"
}
// end of the list of possible fields
}
]
},
"verified_bot": {
"verified": {
"match": "bool"
}
},
"finger_print": {
"ja3_ranges": [
{
// Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`, `defined`, `lists_matchers`
"exact_match": "string",
"exact_not_match": "string",
"prefix_match": "string",
"prefix_not_match": "string",
"pire_regex_match": "string",
"pire_regex_not_match": "string",
"defined": "bool",
"lists_matchers": {
"str_lists_match": {
"list_ids": [
"string"
]
},
"str_lists_not_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_not_match": {
"list_ids": [
"string"
]
}
}
// end of the list of possible fields
}
],
"ja4_ranges": [
{
// Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`, `defined`, `lists_matchers`
"exact_match": "string",
"exact_not_match": "string",
"prefix_match": "string",
"prefix_not_match": "string",
"pire_regex_match": "string",
"pire_regex_not_match": "string",
"defined": "bool",
"lists_matchers": {
"str_lists_match": {
"list_ids": [
"string"
]
},
"str_lists_not_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_not_match": {
"list_ids": [
"string"
]
}
}
// end of the list of possible fields
}
],
"ja3_matcher": {
// Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`, `defined`, `lists_matchers`
"exact_match": "string",
"exact_not_match": "string",
"prefix_match": "string",
"prefix_not_match": "string",
"pire_regex_match": "string",
"pire_regex_not_match": "string",
"defined": "bool",
"lists_matchers": {
"str_lists_match": {
"list_ids": [
"string"
]
},
"str_lists_not_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_not_match": {
"list_ids": [
"string"
]
}
}
// end of the list of possible fields
},
"ja4_matcher": {
// Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`, `defined`, `lists_matchers`
"exact_match": "string",
"exact_not_match": "string",
"prefix_match": "string",
"prefix_not_match": "string",
"pire_regex_match": "string",
"pire_regex_not_match": "string",
"defined": "bool",
"lists_matchers": {
"str_lists_match": {
"list_ids": [
"string"
]
},
"str_lists_not_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_not_match": {
"list_ids": [
"string"
]
}
}
// end of the list of possible fields
}
}
},
"limit": "int64",
"period": "int64"
},
"dynamic_quota": {
"action": "Action",
"condition": {
"authority": {
"authorities": [
{
// Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`, `defined`, `lists_matchers`
"exact_match": "string",
"exact_not_match": "string",
"prefix_match": "string",
"prefix_not_match": "string",
"pire_regex_match": "string",
"pire_regex_not_match": "string",
"defined": "bool",
"lists_matchers": {
"str_lists_match": {
"list_ids": [
"string"
]
},
"str_lists_not_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_not_match": {
"list_ids": [
"string"
]
}
}
// end of the list of possible fields
}
],
"authority_matcher": {
// Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`, `defined`, `lists_matchers`
"exact_match": "string",
"exact_not_match": "string",
"prefix_match": "string",
"prefix_not_match": "string",
"pire_regex_match": "string",
"pire_regex_not_match": "string",
"defined": "bool",
"lists_matchers": {
"str_lists_match": {
"list_ids": [
"string"
]
},
"str_lists_not_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_not_match": {
"list_ids": [
"string"
]
}
}
// end of the list of possible fields
}
},
"http_method": {
"http_methods": [
{
// Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`, `defined`, `lists_matchers`
"exact_match": "string",
"exact_not_match": "string",
"prefix_match": "string",
"prefix_not_match": "string",
"pire_regex_match": "string",
"pire_regex_not_match": "string",
"defined": "bool",
"lists_matchers": {
"str_lists_match": {
"list_ids": [
"string"
]
},
"str_lists_not_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_not_match": {
"list_ids": [
"string"
]
}
}
// end of the list of possible fields
}
],
"http_method_matcher": {
// Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`, `defined`, `lists_matchers`
"exact_match": "string",
"exact_not_match": "string",
"prefix_match": "string",
"prefix_not_match": "string",
"pire_regex_match": "string",
"pire_regex_not_match": "string",
"defined": "bool",
"lists_matchers": {
"str_lists_match": {
"list_ids": [
"string"
]
},
"str_lists_not_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_not_match": {
"list_ids": [
"string"
]
}
}
// end of the list of possible fields
}
},
"request_uri": {
"path": {
// Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`, `defined`, `lists_matchers`
"exact_match": "string",
"exact_not_match": "string",
"prefix_match": "string",
"prefix_not_match": "string",
"pire_regex_match": "string",
"pire_regex_not_match": "string",
"defined": "bool",
"lists_matchers": {
"str_lists_match": {
"list_ids": [
"string"
]
},
"str_lists_not_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_not_match": {
"list_ids": [
"string"
]
}
}
// end of the list of possible fields
},
"queries": [
{
"key": "string",
"value": {
// Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`, `defined`, `lists_matchers`
"exact_match": "string",
"exact_not_match": "string",
"prefix_match": "string",
"prefix_not_match": "string",
"pire_regex_match": "string",
"pire_regex_not_match": "string",
"defined": "bool",
"lists_matchers": {
"str_lists_match": {
"list_ids": [
"string"
]
},
"str_lists_not_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_not_match": {
"list_ids": [
"string"
]
}
}
// end of the list of possible fields
}
}
]
},
"headers": [
{
"name": "string",
"value": {
// Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`, `defined`, `lists_matchers`
"exact_match": "string",
"exact_not_match": "string",
"prefix_match": "string",
"prefix_not_match": "string",
"pire_regex_match": "string",
"pire_regex_not_match": "string",
"defined": "bool",
"lists_matchers": {
"str_lists_match": {
"list_ids": [
"string"
]
},
"str_lists_not_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_not_match": {
"list_ids": [
"string"
]
}
}
// end of the list of possible fields
}
}
],
"source_ip": {
"ip_ranges_match": {
"ip_ranges": [
"string"
]
},
"ip_ranges_not_match": {
"ip_ranges": [
"string"
]
},
"geo_ip_match": {
"locations": [
"string"
]
},
"geo_ip_not_match": {
"locations": [
"string"
]
},
"ip_lists_match": {
"list_ids": [
"string"
]
},
"ip_lists_not_match": {
"list_ids": [
"string"
]
},
"asn_ranges_match": {
"asn_ranges": [
"int64"
]
},
"asn_ranges_not_match": {
"asn_ranges": [
"int64"
]
},
"asn_lists_match": {
"list_ids": [
"string"
]
},
"asn_lists_not_match": {
"list_ids": [
"string"
]
}
},
"cookies": [
{
"name": "string",
"value": {
// Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`, `defined`, `lists_matchers`
"exact_match": "string",
"exact_not_match": "string",
"prefix_match": "string",
"prefix_not_match": "string",
"pire_regex_match": "string",
"pire_regex_not_match": "string",
"defined": "bool",
"lists_matchers": {
"str_lists_match": {
"list_ids": [
"string"
]
},
"str_lists_not_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_not_match": {
"list_ids": [
"string"
]
}
}
// end of the list of possible fields
}
}
],
"bot_category": {
"bot_category_lists_match": {
"list_ids": [
"string"
]
},
"bot_category_lists_not_match": {
"list_ids": [
"string"
]
}
},
"bot_name": {
"bot_name_lists_match": {
"list_ids": [
"string"
]
},
"bot_name_lists_not_match": {
"list_ids": [
"string"
]
}
},
"bot_score": {
"value": [
{
// Includes only one of the fields `le_match`, `ge_match`, `eq_match`, `ne_match`
"le_match": {
"value": "int64"
},
"ge_match": {
"value": "int64"
},
"eq_match": {
"value": "int64"
},
"ne_match": {
"value": "int64"
}
// end of the list of possible fields
}
]
},
"verified_bot": {
"verified": {
"match": "bool"
}
},
"finger_print": {
"ja3_ranges": [
{
// Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`, `defined`, `lists_matchers`
"exact_match": "string",
"exact_not_match": "string",
"prefix_match": "string",
"prefix_not_match": "string",
"pire_regex_match": "string",
"pire_regex_not_match": "string",
"defined": "bool",
"lists_matchers": {
"str_lists_match": {
"list_ids": [
"string"
]
},
"str_lists_not_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_not_match": {
"list_ids": [
"string"
]
}
}
// end of the list of possible fields
}
],
"ja4_ranges": [
{
// Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`, `defined`, `lists_matchers`
"exact_match": "string",
"exact_not_match": "string",
"prefix_match": "string",
"prefix_not_match": "string",
"pire_regex_match": "string",
"pire_regex_not_match": "string",
"defined": "bool",
"lists_matchers": {
"str_lists_match": {
"list_ids": [
"string"
]
},
"str_lists_not_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_not_match": {
"list_ids": [
"string"
]
}
}
// end of the list of possible fields
}
],
"ja3_matcher": {
// Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`, `defined`, `lists_matchers`
"exact_match": "string",
"exact_not_match": "string",
"prefix_match": "string",
"prefix_not_match": "string",
"pire_regex_match": "string",
"pire_regex_not_match": "string",
"defined": "bool",
"lists_matchers": {
"str_lists_match": {
"list_ids": [
"string"
]
},
"str_lists_not_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_not_match": {
"list_ids": [
"string"
]
}
}
// end of the list of possible fields
},
"ja4_matcher": {
// Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`, `defined`, `lists_matchers`
"exact_match": "string",
"exact_not_match": "string",
"prefix_match": "string",
"prefix_not_match": "string",
"pire_regex_match": "string",
"pire_regex_not_match": "string",
"defined": "bool",
"lists_matchers": {
"str_lists_match": {
"list_ids": [
"string"
]
},
"str_lists_not_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_match": {
"list_ids": [
"string"
]
},
"reg_exp_lists_not_match": {
"list_ids": [
"string"
]
}
}
// end of the list of possible fields
}
}
},
"limit": "int64",
"period": "int64",
"characteristics": [
{
// Includes only one of the fields `simple_characteristic`, `key_characteristic`
"simple_characteristic": {
"type": "Type"
},
"key_characteristic": {
"type": "Type",
"value": "string"
},
// end of the list of possible fields
"case_insensitive": "bool"
}
]
},
// end of the list of possible fields
"name": "string",
"priority": "int64",
"description": "string",
"dry_run": "bool"
}
],
"created_at": "google.protobuf.Timestamp",
"cloud_id": "string"
}
]
}
|
Field |
Description |
|
advanced_rate_limiter_profiles[] |
List of AdvancedRateLimiterProfile resources. |
AdvancedRateLimiterProfile
A AdvancedRateLimiterProfile (ARL) resource.
|
Field |
Description |
|
id |
string ID of the ARL profile. |
|
folder_id |
string ID of the folder that the ARL profile belongs to. |
|
labels |
object (map<string, string>) Labels as The maximum string length in characters for each value is 63. The string length in characters for each key must be 1-63. Each key must match the regular expression |
|
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 |
|
description |
string Optional description of the ARL profile. The maximum string length in characters is 512. |
|
advanced_rate_limiter_rules[] |
List of rules. |
|
created_at |
Creation timestamp in RFC3339 text format. |
|
cloud_id |
string ID of the cloud that the ARL profile belongs to. |
AdvancedRateLimiterRule
A AdvancedRateLimiterRule object, see Rules.
|
Field |
Description |
|
static_quota |
Static quota. Counting each request individually. Includes only one of the fields |
|
dynamic_quota |
Dynamic quota. Grouping requests by a certain attribute and limiting the number of groups. Includes only one of the fields |
|
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 |
|
priority |
int64 Determines the priority in case there are several matched rules. 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. |
|
dry_run |
bool This allows you to evaluate backend capabilities and find the optimum limit values. |
StaticQuota
StaticQuota object.
|
Field |
Description |
|
action |
enum Action Required field. Action in case of exceeding this quota.
|
|
condition |
The condition for matching the quota. |
|
limit |
int64 Desired maximum number of requests per period. Acceptable values are 1 to 9999999999999, inclusive. |
|
period |
int64 Period of time in seconds. |
Condition
Condition object. AND semantics implied.
See documentation for matchers description.
|
Field |
Description |
|
authority |
Match authority (Host header). |
|
http_method |
Match HTTP method. |
|
request_uri |
Match Request URI. |
|
headers[] |
Match HTTP headers. The maximum number of elements is 20. |
|
source_ip |
Match IP. |
|
cookies[] |
Match cookies. The maximum number of elements is 20. |
|
bot_category |
Match bot category. |
|
bot_name |
Match bot name. |
|
bot_score |
Match bot score. |
|
verified_bot |
Match verified bot. |
|
finger_print |
Match fingerprint. |
AuthorityMatcher
AuthorityMatcher object.
|
Field |
Description |
|
authorities[] |
List of authorities. OR semantics implied. The maximum number of elements is 20. |
|
authority_matcher |
Authority matcher. |
StringMatcher
StringMatcher object.
|
Field |
Description |
|
exact_match |
string Exact match condition. The string length in characters must be 0-255. Includes only one of the fields |
|
exact_not_match |
string Exact not match condition. The string length in characters must be 0-255. Includes only one of the fields |
|
prefix_match |
string Prefix match condition. The string length in characters must be 0-255. Includes only one of the fields |
|
prefix_not_match |
string Prefix not match condition. The string length in characters must be 0-255. Includes only one of the fields |
|
pire_regex_match |
string PIRE regex match condition. The string length in characters must be 0-255. Includes only one of the fields |
|
pire_regex_not_match |
string PIRE regex not match condition. The string length in characters must be 0-255. Includes only one of the fields |
|
defined |
bool Matches if the field is defined. Includes only one of the fields |
|
lists_matchers |
Matches against string and regular expression lists. Includes only one of the fields |
ListsMatchers
ListsMatchers object.
|
Field |
Description |
|
str_lists_match |
String lists to match with. |
|
str_lists_not_match |
String lists to not match with. |
|
reg_exp_lists_match |
Regular expression lists to match with. |
|
reg_exp_lists_not_match |
Regular expression lists to not match with. |
ListsMatcher
ListsMatcher object.
|
Field |
Description |
|
list_ids[] |
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 |
|
http_methods[] |
List of HTTP methods. OR semantics implied. The maximum number of elements is 20. |
|
http_method_matcher |
HTTP method matcher. |
RequestUriMatcher
RequestUriMatcher object. AND semantics implied.
|
Field |
Description |
|
path |
Path of the URI RFC3986. |
|
queries[] |
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 |
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 |
Required field. Value of the header. |
IpMatcher
IpMatcher object. AND semantics implied.
|
Field |
Description |
|
ip_ranges_match |
IP ranges to match with. |
|
ip_ranges_not_match |
IP ranges to not match with. |
|
geo_ip_match |
Geo locations to match with. |
|
geo_ip_not_match |
Geo locations to not match with. |
|
ip_lists_match |
IP lists to match with. |
|
ip_lists_not_match |
IP lists to not match with. |
|
asn_ranges_match |
ASN ranges to match with. |
|
asn_ranges_not_match |
ASN ranges to not match with. |
|
asn_lists_match |
ASN lists to match with. |
|
asn_lists_not_match |
ASN lists to not match with. |
IpRangesMatcher
IpRangesMatcher object.
|
Field |
Description |
|
ip_ranges[] |
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 |
|
asn_ranges[] |
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 |
Required field. Value of the cookie parametr. |
BotCategoryMatcher
BotCategoryMatcher object. AND semantics implied.
|
Field |
Description |
|
bot_category_lists_match |
Bot category lists to match with. |
|
bot_category_lists_not_match |
Bot category lists to not match with. |
BotNameMatcher
BotNameMatcher object. AND semantics implied.
|
Field |
Description |
|
bot_name_lists_match |
Bot name lists to match with. |
|
bot_name_lists_not_match |
Bot name lists to not match with. |
BotScoreMatcher
BotScoreMatcher object.
|
Field |
Description |
|
value[] |
List of integer matchers for bot score. OR semantics implied. The maximum number of elements is 4. |
IntMatcher
IntMatcher object.
|
Field |
Description |
|
le_match |
Less than or equal condition. Includes only one of the fields |
|
ge_match |
Greater than or equal condition. Includes only one of the fields |
|
eq_match |
Equal condition. Includes only one of the fields |
|
ne_match |
Not equal condition. Includes only one of the fields |
IntLEMatcher
IntLEMatcher object.
|
Field |
Description |
|
value |
int64 Upper bound value (inclusive). |
IntGEMatcher
IntGEMatcher object.
|
Field |
Description |
|
value |
int64 Lower bound value (inclusive). |
IntEQMatcher
IntEQMatcher object.
|
Field |
Description |
|
value |
int64 Value to match against. |
IntNEMatcher
IntNEMatcher object.
|
Field |
Description |
|
value |
int64 Value to not match against. |
VerifiedBotMatcher
VerifiedBotMatcher object.
|
Field |
Description |
|
verified |
Matches if the bot is verified or not. |
BoolMatcher
BoolMatcher object.
|
Field |
Description |
|
match |
bool Boolean value to match against. |
FingerPrintMatcher
FingerPrintMatcher object.
|
Field |
Description |
|
ja3_ranges[] |
List of JA3 fingerprint matchers. OR semantics implied. The maximum number of elements is 20. |
|
ja4_ranges[] |
List of JA4 fingerprint matchers. OR semantics implied. The maximum number of elements is 20. |
|
ja3_matcher |
JA3 fingerprint matcher. |
|
ja4_matcher |
JA4 fingerprint matcher. |
DynamicQuota
DynamicQuota object.
|
Field |
Description |
|
action |
enum Action Required field. Action in case of exceeding this quota.
|
|
condition |
The condition for matching the quota. |
|
limit |
int64 Desired maximum number of requests per period. Acceptable values are 1 to 9999999999999, inclusive. |
|
period |
int64 Period of time in seconds. |
|
characteristics[] |
List of characteristics. The maximum number of elements is 3. |
Characteristic
|
Field |
Description |
|
simple_characteristic |
Characteristic automatically based on the Request path, HTTP method, IP address, Region, and Host attributes. Includes only one of the fields |
|
key_characteristic |
Characteristic based on key match in the Query params, HTTP header, and HTTP cookie attributes. Includes only one of the fields |
|
case_insensitive |
bool Determines case-sensitive or case-insensitive keys matching. |
SimpleCharacteristic
|
Field |
Description |
|
type |
enum Type Type of simple characteristic.
|
KeyCharacteristic
|
Field |
Description |
|
type |
enum Type Type of key characteristic.
|
|
value |
string String value of the key. |