SmartWebSecurity WAF API, gRPC: WafProfileService.Update

Written by

Yandex Cloud

Updated at December 17, 2024

gRPC request
UpdateWafProfileRequest
WafProfileRule
WafProfileExclusionRule
Condition
AuthorityMatcher
StringMatcher
HttpMethodMatcher
RequestUriMatcher
QueryMatcher
HeaderMatcher
IpMatcher
IpRangesMatcher
GeoIpMatcher
ExcludeRules
CoreRuleSet
RuleSet
AnalyzeRequestBody
operation.Operation
UpdateWafProfileMetadata
WafProfile
WafProfileRule
WafProfileExclusionRule
Condition
AuthorityMatcher
StringMatcher
HttpMethodMatcher
RequestUriMatcher
QueryMatcher
HeaderMatcher
IpMatcher
IpRangesMatcher
GeoIpMatcher
ExcludeRules
CoreRuleSet
RuleSet
AnalyzeRequestBody

Updates the specified WAF profile.

gRPC request

rpc Update (UpdateWafProfileRequest) returns (operation.Operation)

UpdateWafProfileRequest

{
  "waf_profile_id": "string",
  "update_mask": "google.protobuf.FieldMask",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "rules": [
    {
      "rule_id": "string",
      "is_enabled": "bool",
      "is_blocking": "bool"
    }
  ],
  "exclusion_rules": [
    {
      "name": "string",
      "description": "string",
      "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`
              "exact_match": "string",
              "exact_not_match": "string",
              "prefix_match": "string",
              "prefix_not_match": "string",
              "pire_regex_match": "string",
              "pire_regex_not_match": "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`
              "exact_match": "string",
              "exact_not_match": "string",
              "prefix_match": "string",
              "prefix_not_match": "string",
              "pire_regex_match": "string",
              "pire_regex_not_match": "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`
            "exact_match": "string",
            "exact_not_match": "string",
            "prefix_match": "string",
            "prefix_not_match": "string",
            "pire_regex_match": "string",
            "pire_regex_not_match": "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`
                "exact_match": "string",
                "exact_not_match": "string",
                "prefix_match": "string",
                "prefix_not_match": "string",
                "pire_regex_match": "string",
                "pire_regex_not_match": "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`
              "exact_match": "string",
              "exact_not_match": "string",
              "prefix_match": "string",
              "prefix_not_match": "string",
              "pire_regex_match": "string",
              "pire_regex_not_match": "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"
            ]
          }
        }
      },
      "exclude_rules": {
        "exclude_all": "bool",
        "rule_ids": [
          "string"
        ]
      },
      "log_excluded": "bool"
    }
  ],
  // Includes only one of the fields `core_rule_set`
  "core_rule_set": {
    "inbound_anomaly_score": "int64",
    "paranoia_level": "int64",
    "rule_set": {
      "name": "string",
      "version": "string"
    }
  },
  // end of the list of possible fields
  "analyze_request_body": {
    "is_enabled": "bool",
    "size_limit": "int64",
    "size_limit_action": "Action"
  }
}

Field	Description
waf_profile_id	string Required field. ID of the WAF profile to update.
update_mask	google.protobuf.FieldMask Field mask that specifies which fields of the WafProfile resource are going to be updated.
name	string Name of the WAF profile. The name is unique within the folder. 1-50 characters long.
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.
exclusion_rules[]	WafProfileExclusionRule List of exclusion rules. See Rules.
core_rule_set	CoreRuleSet Core rule set settings. See Basic rule set for details. Includes only one of the fields `core_rule_set`.
analyze_request_body	AnalyzeRequestBody Parameters for request body analyzer.

WafProfileRule

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

Field	Description
rule_id	string Required field. Rule ID.
is_enabled	bool Determines is it rule enabled or not.
is_blocking	bool 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.
condition	Condition The condition for matching traffic.
exclude_rules	ExcludeRules Required field. Exclude rules.
log_excluded	bool Records the fact that an exception rule is triggered.

Condition

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

Field	Description
authority	AuthorityMatcher Match authority (Host header).
http_method	HttpMethodMatcher Match HTTP method.
request_uri	RequestUriMatcher Match Request URI.
headers[]	HeaderMatcher Match HTTP headers.
source_ip	IpMatcher Match IP.

AuthorityMatcher

AuthorityMatcher object.

Field

Description

authorities[]

StringMatcher

List of authorities. OR semantics implied.

StringMatcher

StringMatcher object.

Field	Description
exact_match	string Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`.
exact_not_match	string Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`.
prefix_match	string Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`.
prefix_not_match	string Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`.
pire_regex_match	string Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`.
pire_regex_not_match	string Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`.

HttpMethodMatcher

HttpMethodMatcher object.

Field

Description

http_methods[]

StringMatcher

List of HTTP methods. OR semantics implied.

RequestUriMatcher

RequestUriMatcher object. AND semantics implied.

Field

Description

path

StringMatcher

Path of the URI RFC3986.

queries[]

QueryMatcher

List of query matchers. AND semantics implied.

QueryMatcher

QueryMatcher object.

Field

Description

key

string

Required field. Key of the query parameter.

value

StringMatcher

Required field. Value of the query parameter.

HeaderMatcher

HeaderMatcher object.

Field

Description

name

string

Required field. Name of header (case insensitive).

value

StringMatcher

Required field. Value of the header.

IpMatcher

IpMatcher object. AND semantics implied.

Field	Description
ip_ranges_match	IpRangesMatcher
ip_ranges_not_match	IpRangesMatcher
geo_ip_match	GeoIpMatcher
geo_ip_not_match	GeoIpMatcher

IpRangesMatcher

IpRangesMatcher object.

Field

Description

ip_ranges[]

string

List of IP ranges. OR semantics implied.

GeoIpMatcher

GeoIpMatcher object.

Field

Description

locations[]

string

ISO 3166-1 alpha 2. OR semantics implied.

ExcludeRules

Determines list of excluded rules.

Field

Description

exclude_all

bool

Set this option true to exclude all rules.

rule_ids[]

string

List of rules to exclude.

CoreRuleSet

Field	Description
inbound_anomaly_score	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.
paranoia_level	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.
rule_set	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.

AnalyzeRequestBody

Field	Description
is_enabled	bool Possible to turn analyzer on and turn if off.
size_limit	int64 Maximum size of body to pass to analyzer. In kilobytes.
size_limit_action	enum Action Action to perform if maximum size of body exceeded. `ACTION_UNSPECIFIED` `IGNORE`: Ignore request. `DENY`: Deny request.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "waf_profile_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folder_id": "string",
    "cloud_id": "string",
    "name": "string",
    "description": "string",
    "labels": "map<string, string>",
    "created_at": "google.protobuf.Timestamp",
    "rules": [
      {
        "rule_id": "string",
        "is_enabled": "bool",
        "is_blocking": "bool"
      }
    ],
    "exclusion_rules": [
      {
        "name": "string",
        "description": "string",
        "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`
                "exact_match": "string",
                "exact_not_match": "string",
                "prefix_match": "string",
                "prefix_not_match": "string",
                "pire_regex_match": "string",
                "pire_regex_not_match": "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`
                "exact_match": "string",
                "exact_not_match": "string",
                "prefix_match": "string",
                "prefix_not_match": "string",
                "pire_regex_match": "string",
                "pire_regex_not_match": "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`
              "exact_match": "string",
              "exact_not_match": "string",
              "prefix_match": "string",
              "prefix_not_match": "string",
              "pire_regex_match": "string",
              "pire_regex_not_match": "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`
                  "exact_match": "string",
                  "exact_not_match": "string",
                  "prefix_match": "string",
                  "prefix_not_match": "string",
                  "pire_regex_match": "string",
                  "pire_regex_not_match": "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`
                "exact_match": "string",
                "exact_not_match": "string",
                "prefix_match": "string",
                "prefix_not_match": "string",
                "pire_regex_match": "string",
                "pire_regex_not_match": "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"
              ]
            }
          }
        },
        "exclude_rules": {
          "exclude_all": "bool",
          "rule_ids": [
            "string"
          ]
        },
        "log_excluded": "bool"
      }
    ],
    // Includes only one of the fields `core_rule_set`
    "core_rule_set": {
      "inbound_anomaly_score": "int64",
      "paranoia_level": "int64",
      "rule_set": {
        "name": "string",
        "version": "string"
      }
    },
    // end of the list of possible fields
    "analyze_request_body": {
      "is_enabled": "bool",
      "size_limit": "int64",
      "size_limit_action": "Action"
    }
  }
  // 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.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	UpdateWafProfileMetadata 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	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	WafProfile 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.

UpdateWafProfileMetadata

Field

Description

waf_profile_id

string

ID of the WafProfile resource that is being updated.

WafProfile

Field	Description
id	string Required field. ID of the WAF profile.
folder_id	string Required field. ID of the folder that the WAF profile belongs to.
cloud_id	string Required field. ID of the cloud that the WAF profile belongs to.
name	string Required field. Name of the WAF profile. The name is unique within the folder. 1-50 characters long.
description	string Optional description of the WAF profile.
labels	object (map<string, string>) Labels as `key:value` pairs. Maximum of 64 per resource.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format.
rules[]	WafProfileRule Settings for each rule in rule set.
exclusion_rules[]	WafProfileExclusionRule List of exclusion rules. See Rules.
core_rule_set	CoreRuleSet Core rule set settings. See Basic rule set for details. Includes only one of the fields `core_rule_set`.
analyze_request_body	AnalyzeRequestBody Parameters for request body analyzer.

WafProfileRule

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

Field	Description
rule_id	string Required field. Rule ID.
is_enabled	bool Determines is it rule enabled or not.
is_blocking	bool 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.
condition	Condition The condition for matching traffic.
exclude_rules	ExcludeRules Required field. Exclude rules.
log_excluded	bool Records the fact that an exception rule is triggered.

Condition

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

Field	Description
authority	AuthorityMatcher Match authority (Host header).
http_method	HttpMethodMatcher Match HTTP method.
request_uri	RequestUriMatcher Match Request URI.
headers[]	HeaderMatcher Match HTTP headers.
source_ip	IpMatcher Match IP.

AuthorityMatcher

AuthorityMatcher object.

Field

Description

authorities[]

StringMatcher

List of authorities. OR semantics implied.

StringMatcher

StringMatcher object.

Field	Description
exact_match	string Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`.
exact_not_match	string Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`.
prefix_match	string Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`.
prefix_not_match	string Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`.
pire_regex_match	string Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`.
pire_regex_not_match	string Includes only one of the fields `exact_match`, `exact_not_match`, `prefix_match`, `prefix_not_match`, `pire_regex_match`, `pire_regex_not_match`.

HttpMethodMatcher

HttpMethodMatcher object.

Field

Description

http_methods[]

StringMatcher

List of HTTP methods. OR semantics implied.

RequestUriMatcher

RequestUriMatcher object. AND semantics implied.

Field

Description

path

StringMatcher

Path of the URI RFC3986.

queries[]

QueryMatcher

List of query matchers. AND semantics implied.

QueryMatcher

QueryMatcher object.

Field

Description

key

string

Required field. Key of the query parameter.

value

StringMatcher

Required field. Value of the query parameter.

HeaderMatcher

HeaderMatcher object.

Field

Description

name

string

Required field. Name of header (case insensitive).

value

StringMatcher

Required field. Value of the header.

IpMatcher

IpMatcher object. AND semantics implied.

Field	Description
ip_ranges_match	IpRangesMatcher
ip_ranges_not_match	IpRangesMatcher
geo_ip_match	GeoIpMatcher
geo_ip_not_match	GeoIpMatcher

IpRangesMatcher

IpRangesMatcher object.

Field

Description

ip_ranges[]

string

List of IP ranges. OR semantics implied.

GeoIpMatcher

GeoIpMatcher object.

Field

Description

locations[]

string

ISO 3166-1 alpha 2. OR semantics implied.

ExcludeRules

Determines list of excluded rules.

Field

Description

exclude_all

bool

Set this option true to exclude all rules.

rule_ids[]

string

List of rules to exclude.

CoreRuleSet

Field	Description
inbound_anomaly_score	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.
paranoia_level	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.
rule_set	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.

AnalyzeRequestBody

Field	Description
is_enabled	bool Possible to turn analyzer on and turn if off.
size_limit	int64 Maximum size of body to pass to analyzer. In kilobytes.
size_limit_action	enum Action Action to perform if maximum size of body exceeded. `ACTION_UNSPECIFIED` `IGNORE`: Ignore request. `DENY`: Deny request.

SmartWebSecurity WAF API, gRPC: WafProfileService.Update

gRPC requestgRPC request

UpdateWafProfileRequestUpdateWafProfileRequest

WafProfileRuleWafProfileRule

WafProfileExclusionRuleWafProfileExclusionRule

ConditionCondition

AuthorityMatcherAuthorityMatcher

StringMatcherStringMatcher

HttpMethodMatcherHttpMethodMatcher

RequestUriMatcherRequestUriMatcher

QueryMatcherQueryMatcher

HeaderMatcherHeaderMatcher

IpMatcherIpMatcher

IpRangesMatcherIpRangesMatcher

GeoIpMatcherGeoIpMatcher

ExcludeRulesExcludeRules

CoreRuleSetCoreRuleSet

RuleSetRuleSet

AnalyzeRequestBodyAnalyzeRequestBody

operation.Operationoperation.Operation

UpdateWafProfileMetadataUpdateWafProfileMetadata

WafProfileWafProfile

WafProfileRuleWafProfileRule

WafProfileExclusionRuleWafProfileExclusionRule

ConditionCondition

AuthorityMatcherAuthorityMatcher

StringMatcherStringMatcher

HttpMethodMatcherHttpMethodMatcher

RequestUriMatcherRequestUriMatcher

QueryMatcherQueryMatcher

HeaderMatcherHeaderMatcher

IpMatcherIpMatcher

IpRangesMatcherIpRangesMatcher

GeoIpMatcherGeoIpMatcher

ExcludeRulesExcludeRules

CoreRuleSetCoreRuleSet

RuleSetRuleSet

AnalyzeRequestBodyAnalyzeRequestBody

Was the article helpful?

gRPC request

UpdateWafProfileRequest

WafProfileRule

WafProfileExclusionRule

Condition

AuthorityMatcher

StringMatcher

HttpMethodMatcher

RequestUriMatcher

QueryMatcher

HeaderMatcher

IpMatcher

IpRangesMatcher

GeoIpMatcher

ExcludeRules

CoreRuleSet

RuleSet

AnalyzeRequestBody

operation.Operation

UpdateWafProfileMetadata

WafProfile

WafProfileRule

WafProfileExclusionRule

Condition

AuthorityMatcher

StringMatcher

HttpMethodMatcher

RequestUriMatcher

QueryMatcher

HeaderMatcher

IpMatcher

IpRangesMatcher

GeoIpMatcher

ExcludeRules

CoreRuleSet

RuleSet

AnalyzeRequestBody