SmartWebSecurity API, REST: SecurityProfile.update
Updates the specified security profile.
HTTP request
PATCH https://smartwebsecurity.api.cloud.yandex.net/smartwebsecurity/v1/securityProfiles/{securityProfileId}
Path parameters
Parameter | Description |
---|---|
securityProfileId | Required. ID of the security profile to update. |
Body parameters
{
"updateMask": "string",
"labels": "object",
"name": "string",
"description": "string",
"defaultAction": "string",
"securityRules": [
{
"name": "string",
"priority": "string",
"dryRun": true,
"description": "string",
// `securityRules[]` includes only one of the fields `ruleCondition`, `smartProtection`, `waf`
"ruleCondition": {
"action": "string",
"condition": {
"authority": {
"authorities": [
{
// `securityRules[].ruleCondition.condition.authority.authorities[]` includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`
"exactMatch": "string",
"exactNotMatch": "string",
"prefixMatch": "string",
"prefixNotMatch": "string",
"pireRegexMatch": "string",
"pireRegexNotMatch": "string",
// end of the list of possible fields`securityRules[].ruleCondition.condition.authority.authorities[]`
}
]
},
"httpMethod": {
"httpMethods": [
{
// `securityRules[].ruleCondition.condition.httpMethod.httpMethods[]` includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`
"exactMatch": "string",
"exactNotMatch": "string",
"prefixMatch": "string",
"prefixNotMatch": "string",
"pireRegexMatch": "string",
"pireRegexNotMatch": "string",
// end of the list of possible fields`securityRules[].ruleCondition.condition.httpMethod.httpMethods[]`
}
]
},
"requestUri": {
"path": {
// `securityRules[].ruleCondition.condition.requestUri.path` includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`
"exactMatch": "string",
"exactNotMatch": "string",
"prefixMatch": "string",
"prefixNotMatch": "string",
"pireRegexMatch": "string",
"pireRegexNotMatch": "string",
// end of the list of possible fields`securityRules[].ruleCondition.condition.requestUri.path`
},
"queries": [
{
"key": "string",
"value": {
// `securityRules[].ruleCondition.condition.requestUri.queries[].value` includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`
"exactMatch": "string",
"exactNotMatch": "string",
"prefixMatch": "string",
"prefixNotMatch": "string",
"pireRegexMatch": "string",
"pireRegexNotMatch": "string",
// end of the list of possible fields`securityRules[].ruleCondition.condition.requestUri.queries[].value`
}
}
]
},
"headers": [
{
"name": "string",
"value": {
// `securityRules[].ruleCondition.condition.headers[].value` includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`
"exactMatch": "string",
"exactNotMatch": "string",
"prefixMatch": "string",
"prefixNotMatch": "string",
"pireRegexMatch": "string",
"pireRegexNotMatch": "string",
// end of the list of possible fields`securityRules[].ruleCondition.condition.headers[].value`
}
}
],
"sourceIp": {
"ipRangesMatch": {
"ipRanges": [
"string"
]
},
"ipRangesNotMatch": {
"ipRanges": [
"string"
]
},
"geoIpMatch": {
"locations": [
"string"
]
},
"geoIpNotMatch": {
"locations": [
"string"
]
}
}
}
},
"smartProtection": {
"mode": "string",
"condition": {
"authority": {
"authorities": [
{
// `securityRules[].smartProtection.condition.authority.authorities[]` includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`
"exactMatch": "string",
"exactNotMatch": "string",
"prefixMatch": "string",
"prefixNotMatch": "string",
"pireRegexMatch": "string",
"pireRegexNotMatch": "string",
// end of the list of possible fields`securityRules[].smartProtection.condition.authority.authorities[]`
}
]
},
"httpMethod": {
"httpMethods": [
{
// `securityRules[].smartProtection.condition.httpMethod.httpMethods[]` includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`
"exactMatch": "string",
"exactNotMatch": "string",
"prefixMatch": "string",
"prefixNotMatch": "string",
"pireRegexMatch": "string",
"pireRegexNotMatch": "string",
// end of the list of possible fields`securityRules[].smartProtection.condition.httpMethod.httpMethods[]`
}
]
},
"requestUri": {
"path": {
// `securityRules[].smartProtection.condition.requestUri.path` includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`
"exactMatch": "string",
"exactNotMatch": "string",
"prefixMatch": "string",
"prefixNotMatch": "string",
"pireRegexMatch": "string",
"pireRegexNotMatch": "string",
// end of the list of possible fields`securityRules[].smartProtection.condition.requestUri.path`
},
"queries": [
{
"key": "string",
"value": {
// `securityRules[].smartProtection.condition.requestUri.queries[].value` includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`
"exactMatch": "string",
"exactNotMatch": "string",
"prefixMatch": "string",
"prefixNotMatch": "string",
"pireRegexMatch": "string",
"pireRegexNotMatch": "string",
// end of the list of possible fields`securityRules[].smartProtection.condition.requestUri.queries[].value`
}
}
]
},
"headers": [
{
"name": "string",
"value": {
// `securityRules[].smartProtection.condition.headers[].value` includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`
"exactMatch": "string",
"exactNotMatch": "string",
"prefixMatch": "string",
"prefixNotMatch": "string",
"pireRegexMatch": "string",
"pireRegexNotMatch": "string",
// end of the list of possible fields`securityRules[].smartProtection.condition.headers[].value`
}
}
],
"sourceIp": {
"ipRangesMatch": {
"ipRanges": [
"string"
]
},
"ipRangesNotMatch": {
"ipRanges": [
"string"
]
},
"geoIpMatch": {
"locations": [
"string"
]
},
"geoIpNotMatch": {
"locations": [
"string"
]
}
}
}
},
"waf": {
"mode": "string",
"condition": {
"authority": {
"authorities": [
{
// `securityRules[].waf.condition.authority.authorities[]` includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`
"exactMatch": "string",
"exactNotMatch": "string",
"prefixMatch": "string",
"prefixNotMatch": "string",
"pireRegexMatch": "string",
"pireRegexNotMatch": "string",
// end of the list of possible fields`securityRules[].waf.condition.authority.authorities[]`
}
]
},
"httpMethod": {
"httpMethods": [
{
// `securityRules[].waf.condition.httpMethod.httpMethods[]` includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`
"exactMatch": "string",
"exactNotMatch": "string",
"prefixMatch": "string",
"prefixNotMatch": "string",
"pireRegexMatch": "string",
"pireRegexNotMatch": "string",
// end of the list of possible fields`securityRules[].waf.condition.httpMethod.httpMethods[]`
}
]
},
"requestUri": {
"path": {
// `securityRules[].waf.condition.requestUri.path` includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`
"exactMatch": "string",
"exactNotMatch": "string",
"prefixMatch": "string",
"prefixNotMatch": "string",
"pireRegexMatch": "string",
"pireRegexNotMatch": "string",
// end of the list of possible fields`securityRules[].waf.condition.requestUri.path`
},
"queries": [
{
"key": "string",
"value": {
// `securityRules[].waf.condition.requestUri.queries[].value` includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`
"exactMatch": "string",
"exactNotMatch": "string",
"prefixMatch": "string",
"prefixNotMatch": "string",
"pireRegexMatch": "string",
"pireRegexNotMatch": "string",
// end of the list of possible fields`securityRules[].waf.condition.requestUri.queries[].value`
}
}
]
},
"headers": [
{
"name": "string",
"value": {
// `securityRules[].waf.condition.headers[].value` includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`
"exactMatch": "string",
"exactNotMatch": "string",
"prefixMatch": "string",
"prefixNotMatch": "string",
"pireRegexMatch": "string",
"pireRegexNotMatch": "string",
// end of the list of possible fields`securityRules[].waf.condition.headers[].value`
}
}
],
"sourceIp": {
"ipRangesMatch": {
"ipRanges": [
"string"
]
},
"ipRangesNotMatch": {
"ipRanges": [
"string"
]
},
"geoIpMatch": {
"locations": [
"string"
]
},
"geoIpNotMatch": {
"locations": [
"string"
]
}
}
},
"wafProfileId": "string"
},
// end of the list of possible fields`securityRules[]`
}
],
"captchaId": "string",
"advancedRateLimiterProfileId": "string"
}
Field | Description |
---|---|
updateMask | string Field mask that specifies which fields of the SecurityProfile resource are going to be updated. 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 If |
labels | object Labels as |
name | string Name of the security profile. The name is unique within the folder. 1-50 characters long. |
description | string Optional description of the security profile. |
defaultAction | string Action to perform if none of rules matched. Action to perform if none of rules matched.
|
securityRules[] | object List of security rules. |
securityRules[]. name |
string Required. Name of the rule. The name is unique within the security profile. 1-50 characters long. The string length in characters must be 1-50. Value must match the regular expression |
securityRules[]. priority |
string (int64) Determines the priority for checking the incoming traffic. Enter an integer within the range of 1 and 999999. The rule priority must be unique within the entire security profile. A lower numeric value means a higher priority. The default_action has the lowest priority. Acceptable values are 1 to 999999, inclusive. |
securityRules[]. dryRun |
boolean (boolean) This mode allows you to test your security profile or a single rule. For example, you can have the number of alarms for a specific rule displayed. Note: if this option is true, no real action affecting your traffic regarding this rule will be taken. |
securityRules[]. description |
string Optional description of the rule. 0-512 characters long. The maximum string length in characters is 512. |
securityRules[]. ruleCondition |
object Rule actions, see Rule actions. securityRules[] includes only one of the fields ruleCondition , smartProtection , waf |
securityRules[]. ruleCondition. action |
string Action to perform if this rule matched. Type of action to perform if this rule matched.
|
securityRules[]. ruleCondition. condition |
object The condition for matching the rule. Condition object. AND semantics implied. See documentation for matchers description. |
securityRules[]. ruleCondition. condition. authority |
object Match authority (Host header). AuthorityMatcher object. |
securityRules[]. ruleCondition. condition. authority. authorities[] |
object List of authorities. OR semantics implied. The maximum number of elements is 20. |
securityRules[]. ruleCondition. condition. authority. authorities[]. exactMatch |
string securityRules[].ruleCondition.condition.authority.authorities[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. authority. authorities[]. exactNotMatch |
string securityRules[].ruleCondition.condition.authority.authorities[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. authority. authorities[]. prefixMatch |
string securityRules[].ruleCondition.condition.authority.authorities[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. authority. authorities[]. prefixNotMatch |
string securityRules[].ruleCondition.condition.authority.authorities[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. authority. authorities[]. pireRegexMatch |
string securityRules[].ruleCondition.condition.authority.authorities[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. authority. authorities[]. pireRegexNotMatch |
string securityRules[].ruleCondition.condition.authority.authorities[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. httpMethod |
object Match HTTP method. HttpMethodMatcher object. |
securityRules[]. ruleCondition. condition. httpMethod. httpMethods[] |
object List of HTTP methods. OR semantics implied. The maximum number of elements is 20. |
securityRules[]. ruleCondition. condition. httpMethod. httpMethods[]. exactMatch |
string securityRules[].ruleCondition.condition.httpMethod.httpMethods[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. httpMethod. httpMethods[]. exactNotMatch |
string securityRules[].ruleCondition.condition.httpMethod.httpMethods[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. httpMethod. httpMethods[]. prefixMatch |
string securityRules[].ruleCondition.condition.httpMethod.httpMethods[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. httpMethod. httpMethods[]. prefixNotMatch |
string securityRules[].ruleCondition.condition.httpMethod.httpMethods[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. httpMethod. httpMethods[]. pireRegexMatch |
string securityRules[].ruleCondition.condition.httpMethod.httpMethods[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. httpMethod. httpMethods[]. pireRegexNotMatch |
string securityRules[].ruleCondition.condition.httpMethod.httpMethods[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. requestUri |
object Match Request URI. RequestUriMatcher object. AND semantics implied. |
securityRules[]. ruleCondition. condition. requestUri. path |
object Path of the URI RFC3986. StringMatcher object. |
securityRules[]. ruleCondition. condition. requestUri. path. exactMatch |
string securityRules[].ruleCondition.condition.requestUri.path includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. requestUri. path. exactNotMatch |
string securityRules[].ruleCondition.condition.requestUri.path includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. requestUri. path. prefixMatch |
string securityRules[].ruleCondition.condition.requestUri.path includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. requestUri. path. prefixNotMatch |
string securityRules[].ruleCondition.condition.requestUri.path includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. requestUri. path. pireRegexMatch |
string securityRules[].ruleCondition.condition.requestUri.path includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. requestUri. path. pireRegexNotMatch |
string securityRules[].ruleCondition.condition.requestUri.path includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. requestUri. queries[] |
object List of query matchers. AND semantics implied. The maximum number of elements is 20. |
securityRules[]. ruleCondition. condition. requestUri. queries[]. key |
string Required. Key of the query parameter. The string length in characters must be 1-255. |
securityRules[]. ruleCondition. condition. requestUri. queries[]. value |
object Required. Value of the query parameter. StringMatcher object. |
securityRules[]. ruleCondition. condition. requestUri. queries[]. value. exactMatch |
string securityRules[].ruleCondition.condition.requestUri.queries[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. requestUri. queries[]. value. exactNotMatch |
string securityRules[].ruleCondition.condition.requestUri.queries[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. requestUri. queries[]. value. prefixMatch |
string securityRules[].ruleCondition.condition.requestUri.queries[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. requestUri. queries[]. value. prefixNotMatch |
string securityRules[].ruleCondition.condition.requestUri.queries[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. requestUri. queries[]. value. pireRegexMatch |
string securityRules[].ruleCondition.condition.requestUri.queries[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. requestUri. queries[]. value. pireRegexNotMatch |
string securityRules[].ruleCondition.condition.requestUri.queries[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. headers[] |
object Match HTTP headers. The maximum number of elements is 20. |
securityRules[]. ruleCondition. condition. headers[]. name |
string Required. Name of header (case insensitive). The string length in characters must be 1-255. |
securityRules[]. ruleCondition. condition. headers[]. value |
object Required. Value of the header. StringMatcher object. |
securityRules[]. ruleCondition. condition. headers[]. value. exactMatch |
string securityRules[].ruleCondition.condition.headers[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. headers[]. value. exactNotMatch |
string securityRules[].ruleCondition.condition.headers[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. headers[]. value. prefixMatch |
string securityRules[].ruleCondition.condition.headers[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. headers[]. value. prefixNotMatch |
string securityRules[].ruleCondition.condition.headers[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. headers[]. value. pireRegexMatch |
string securityRules[].ruleCondition.condition.headers[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. headers[]. value. pireRegexNotMatch |
string securityRules[].ruleCondition.condition.headers[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. ruleCondition. condition. sourceIp |
object Match IP. IpMatcher object. AND semantics implied. |
securityRules[]. ruleCondition. condition. sourceIp. ipRangesMatch |
object IpRangesMatcher object. |
securityRules[]. ruleCondition. condition. sourceIp. ipRangesMatch. ipRanges[] |
string List of IP ranges. OR semantics implied. The maximum number of elements is 10000. |
securityRules[]. ruleCondition. condition. sourceIp. ipRangesNotMatch |
object IpRangesMatcher object. |
securityRules[]. ruleCondition. condition. sourceIp. ipRangesNotMatch. ipRanges[] |
string List of IP ranges. OR semantics implied. The maximum number of elements is 10000. |
securityRules[]. ruleCondition. condition. sourceIp. geoIpMatch |
object GeoIpMatcher object. |
securityRules[]. ruleCondition. condition. sourceIp. geoIpMatch. locations[] |
string Required. ISO 3166-1 alpha 2. OR semantics implied. The minimum number of elements is 1. The string length in characters for each value must be equal to 2. |
securityRules[]. ruleCondition. condition. sourceIp. geoIpNotMatch |
object GeoIpMatcher object. |
securityRules[]. ruleCondition. condition. sourceIp. geoIpNotMatch. locations[] |
string Required. ISO 3166-1 alpha 2. OR semantics implied. The minimum number of elements is 1. The string length in characters for each value must be equal to 2. |
securityRules[]. smartProtection |
object Smart Protection rule, see Smart Protection rules. securityRules[] includes only one of the fields ruleCondition , smartProtection , waf |
securityRules[]. smartProtection. mode |
string Mode of protection. Mode of protection.
|
securityRules[]. smartProtection. condition |
object The condition for matching the rule. Condition object. AND semantics implied. See documentation for matchers description. |
securityRules[]. smartProtection. condition. authority |
object Match authority (Host header). AuthorityMatcher object. |
securityRules[]. smartProtection. condition. authority. authorities[] |
object List of authorities. OR semantics implied. The maximum number of elements is 20. |
securityRules[]. smartProtection. condition. authority. authorities[]. exactMatch |
string securityRules[].smartProtection.condition.authority.authorities[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. authority. authorities[]. exactNotMatch |
string securityRules[].smartProtection.condition.authority.authorities[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. authority. authorities[]. prefixMatch |
string securityRules[].smartProtection.condition.authority.authorities[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. authority. authorities[]. prefixNotMatch |
string securityRules[].smartProtection.condition.authority.authorities[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. authority. authorities[]. pireRegexMatch |
string securityRules[].smartProtection.condition.authority.authorities[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. authority. authorities[]. pireRegexNotMatch |
string securityRules[].smartProtection.condition.authority.authorities[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. httpMethod |
object Match HTTP method. HttpMethodMatcher object. |
securityRules[]. smartProtection. condition. httpMethod. httpMethods[] |
object List of HTTP methods. OR semantics implied. The maximum number of elements is 20. |
securityRules[]. smartProtection. condition. httpMethod. httpMethods[]. exactMatch |
string securityRules[].smartProtection.condition.httpMethod.httpMethods[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. httpMethod. httpMethods[]. exactNotMatch |
string securityRules[].smartProtection.condition.httpMethod.httpMethods[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. httpMethod. httpMethods[]. prefixMatch |
string securityRules[].smartProtection.condition.httpMethod.httpMethods[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. httpMethod. httpMethods[]. prefixNotMatch |
string securityRules[].smartProtection.condition.httpMethod.httpMethods[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. httpMethod. httpMethods[]. pireRegexMatch |
string securityRules[].smartProtection.condition.httpMethod.httpMethods[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. httpMethod. httpMethods[]. pireRegexNotMatch |
string securityRules[].smartProtection.condition.httpMethod.httpMethods[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. requestUri |
object Match Request URI. RequestUriMatcher object. AND semantics implied. |
securityRules[]. smartProtection. condition. requestUri. path |
object Path of the URI RFC3986. StringMatcher object. |
securityRules[]. smartProtection. condition. requestUri. path. exactMatch |
string securityRules[].smartProtection.condition.requestUri.path includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. requestUri. path. exactNotMatch |
string securityRules[].smartProtection.condition.requestUri.path includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. requestUri. path. prefixMatch |
string securityRules[].smartProtection.condition.requestUri.path includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. requestUri. path. prefixNotMatch |
string securityRules[].smartProtection.condition.requestUri.path includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. requestUri. path. pireRegexMatch |
string securityRules[].smartProtection.condition.requestUri.path includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. requestUri. path. pireRegexNotMatch |
string securityRules[].smartProtection.condition.requestUri.path includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. requestUri. queries[] |
object List of query matchers. AND semantics implied. The maximum number of elements is 20. |
securityRules[]. smartProtection. condition. requestUri. queries[]. key |
string Required. Key of the query parameter. The string length in characters must be 1-255. |
securityRules[]. smartProtection. condition. requestUri. queries[]. value |
object Required. Value of the query parameter. StringMatcher object. |
securityRules[]. smartProtection. condition. requestUri. queries[]. value. exactMatch |
string securityRules[].smartProtection.condition.requestUri.queries[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. requestUri. queries[]. value. exactNotMatch |
string securityRules[].smartProtection.condition.requestUri.queries[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. requestUri. queries[]. value. prefixMatch |
string securityRules[].smartProtection.condition.requestUri.queries[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. requestUri. queries[]. value. prefixNotMatch |
string securityRules[].smartProtection.condition.requestUri.queries[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. requestUri. queries[]. value. pireRegexMatch |
string securityRules[].smartProtection.condition.requestUri.queries[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. requestUri. queries[]. value. pireRegexNotMatch |
string securityRules[].smartProtection.condition.requestUri.queries[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. headers[] |
object Match HTTP headers. The maximum number of elements is 20. |
securityRules[]. smartProtection. condition. headers[]. name |
string Required. Name of header (case insensitive). The string length in characters must be 1-255. |
securityRules[]. smartProtection. condition. headers[]. value |
object Required. Value of the header. StringMatcher object. |
securityRules[]. smartProtection. condition. headers[]. value. exactMatch |
string securityRules[].smartProtection.condition.headers[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. headers[]. value. exactNotMatch |
string securityRules[].smartProtection.condition.headers[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. headers[]. value. prefixMatch |
string securityRules[].smartProtection.condition.headers[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. headers[]. value. prefixNotMatch |
string securityRules[].smartProtection.condition.headers[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. headers[]. value. pireRegexMatch |
string securityRules[].smartProtection.condition.headers[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. headers[]. value. pireRegexNotMatch |
string securityRules[].smartProtection.condition.headers[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. smartProtection. condition. sourceIp |
object Match IP. IpMatcher object. AND semantics implied. |
securityRules[]. smartProtection. condition. sourceIp. ipRangesMatch |
object IpRangesMatcher object. |
securityRules[]. smartProtection. condition. sourceIp. ipRangesMatch. ipRanges[] |
string List of IP ranges. OR semantics implied. The maximum number of elements is 10000. |
securityRules[]. smartProtection. condition. sourceIp. ipRangesNotMatch |
object IpRangesMatcher object. |
securityRules[]. smartProtection. condition. sourceIp. ipRangesNotMatch. ipRanges[] |
string List of IP ranges. OR semantics implied. The maximum number of elements is 10000. |
securityRules[]. smartProtection. condition. sourceIp. geoIpMatch |
object GeoIpMatcher object. |
securityRules[]. smartProtection. condition. sourceIp. geoIpMatch. locations[] |
string Required. ISO 3166-1 alpha 2. OR semantics implied. The minimum number of elements is 1. The string length in characters for each value must be equal to 2. |
securityRules[]. smartProtection. condition. sourceIp. geoIpNotMatch |
object GeoIpMatcher object. |
securityRules[]. smartProtection. condition. sourceIp. geoIpNotMatch. locations[] |
string Required. ISO 3166-1 alpha 2. OR semantics implied. The minimum number of elements is 1. The string length in characters for each value must be equal to 2. |
securityRules[]. waf |
object Web Application Firewall (WAF) rule, see WAF rules. securityRules[] includes only one of the fields ruleCondition , smartProtection , waf |
securityRules[]. waf. mode |
string Mode of protection. Mode of protection.
|
securityRules[]. waf. condition |
object The condition for matching the rule. Condition object. AND semantics implied. See documentation for matchers description. |
securityRules[]. waf. condition. authority |
object Match authority (Host header). AuthorityMatcher object. |
securityRules[]. waf. condition. authority. authorities[] |
object List of authorities. OR semantics implied. The maximum number of elements is 20. |
securityRules[]. waf. condition. authority. authorities[]. exactMatch |
string securityRules[].waf.condition.authority.authorities[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. authority. authorities[]. exactNotMatch |
string securityRules[].waf.condition.authority.authorities[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. authority. authorities[]. prefixMatch |
string securityRules[].waf.condition.authority.authorities[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. authority. authorities[]. prefixNotMatch |
string securityRules[].waf.condition.authority.authorities[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. authority. authorities[]. pireRegexMatch |
string securityRules[].waf.condition.authority.authorities[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. authority. authorities[]. pireRegexNotMatch |
string securityRules[].waf.condition.authority.authorities[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. httpMethod |
object Match HTTP method. HttpMethodMatcher object. |
securityRules[]. waf. condition. httpMethod. httpMethods[] |
object List of HTTP methods. OR semantics implied. The maximum number of elements is 20. |
securityRules[]. waf. condition. httpMethod. httpMethods[]. exactMatch |
string securityRules[].waf.condition.httpMethod.httpMethods[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. httpMethod. httpMethods[]. exactNotMatch |
string securityRules[].waf.condition.httpMethod.httpMethods[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. httpMethod. httpMethods[]. prefixMatch |
string securityRules[].waf.condition.httpMethod.httpMethods[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. httpMethod. httpMethods[]. prefixNotMatch |
string securityRules[].waf.condition.httpMethod.httpMethods[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. httpMethod. httpMethods[]. pireRegexMatch |
string securityRules[].waf.condition.httpMethod.httpMethods[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. httpMethod. httpMethods[]. pireRegexNotMatch |
string securityRules[].waf.condition.httpMethod.httpMethods[] includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. requestUri |
object Match Request URI. RequestUriMatcher object. AND semantics implied. |
securityRules[]. waf. condition. requestUri. path |
object Path of the URI RFC3986. StringMatcher object. |
securityRules[]. waf. condition. requestUri. path. exactMatch |
string securityRules[].waf.condition.requestUri.path includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. requestUri. path. exactNotMatch |
string securityRules[].waf.condition.requestUri.path includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. requestUri. path. prefixMatch |
string securityRules[].waf.condition.requestUri.path includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. requestUri. path. prefixNotMatch |
string securityRules[].waf.condition.requestUri.path includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. requestUri. path. pireRegexMatch |
string securityRules[].waf.condition.requestUri.path includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. requestUri. path. pireRegexNotMatch |
string securityRules[].waf.condition.requestUri.path includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. requestUri. queries[] |
object List of query matchers. AND semantics implied. The maximum number of elements is 20. |
securityRules[]. waf. condition. requestUri. queries[]. key |
string Required. Key of the query parameter. The string length in characters must be 1-255. |
securityRules[]. waf. condition. requestUri. queries[]. value |
object Required. Value of the query parameter. StringMatcher object. |
securityRules[]. waf. condition. requestUri. queries[]. value. exactMatch |
string securityRules[].waf.condition.requestUri.queries[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. requestUri. queries[]. value. exactNotMatch |
string securityRules[].waf.condition.requestUri.queries[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. requestUri. queries[]. value. prefixMatch |
string securityRules[].waf.condition.requestUri.queries[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. requestUri. queries[]. value. prefixNotMatch |
string securityRules[].waf.condition.requestUri.queries[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. requestUri. queries[]. value. pireRegexMatch |
string securityRules[].waf.condition.requestUri.queries[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. requestUri. queries[]. value. pireRegexNotMatch |
string securityRules[].waf.condition.requestUri.queries[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. headers[] |
object Match HTTP headers. The maximum number of elements is 20. |
securityRules[]. waf. condition. headers[]. name |
string Required. Name of header (case insensitive). The string length in characters must be 1-255. |
securityRules[]. waf. condition. headers[]. value |
object Required. Value of the header. StringMatcher object. |
securityRules[]. waf. condition. headers[]. value. exactMatch |
string securityRules[].waf.condition.headers[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. headers[]. value. exactNotMatch |
string securityRules[].waf.condition.headers[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. headers[]. value. prefixMatch |
string securityRules[].waf.condition.headers[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. headers[]. value. prefixNotMatch |
string securityRules[].waf.condition.headers[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. headers[]. value. pireRegexMatch |
string securityRules[].waf.condition.headers[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. headers[]. value. pireRegexNotMatch |
string securityRules[].waf.condition.headers[].value includes only one of the fields exactMatch , exactNotMatch , prefixMatch , prefixNotMatch , pireRegexMatch , pireRegexNotMatch The string length in characters must be 0-255. |
securityRules[]. waf. condition. sourceIp |
object Match IP. IpMatcher object. AND semantics implied. |
securityRules[]. waf. condition. sourceIp. ipRangesMatch |
object IpRangesMatcher object. |
securityRules[]. waf. condition. sourceIp. ipRangesMatch. ipRanges[] |
string List of IP ranges. OR semantics implied. The maximum number of elements is 10000. |
securityRules[]. waf. condition. sourceIp. ipRangesNotMatch |
object IpRangesMatcher object. |
securityRules[]. waf. condition. sourceIp. ipRangesNotMatch. ipRanges[] |
string List of IP ranges. OR semantics implied. The maximum number of elements is 10000. |
securityRules[]. waf. condition. sourceIp. geoIpMatch |
object GeoIpMatcher object. |
securityRules[]. waf. condition. sourceIp. geoIpMatch. locations[] |
string Required. ISO 3166-1 alpha 2. OR semantics implied. The minimum number of elements is 1. The string length in characters for each value must be equal to 2. |
securityRules[]. waf. condition. sourceIp. geoIpNotMatch |
object GeoIpMatcher object. |
securityRules[]. waf. condition. sourceIp. geoIpNotMatch. locations[] |
string Required. ISO 3166-1 alpha 2. OR semantics implied. The minimum number of elements is 1. The string length in characters for each value must be equal to 2. |
securityRules[]. waf. wafProfileId |
string Required. ID of WAF profile to use in this rule. |
captchaId | string Captcha ID to use with this security profile. Set empty to use default. |
advancedRateLimiterProfileId | string Advanced rate limiter profile ID to use with this security profile. Set empty to use default. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": true,
"metadata": "object",
// includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": "object",
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
createdAt | string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
createdBy | string ID of the user or service account who initiated the operation. |
modifiedAt | string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
done | boolean (boolean) If the value is |
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 | object The error result of the operation in case of failure or cancellation. includes only one of the fields error , response |
error. code |
integer (int32) Error code. An enum value of google.rpc.Code. |
error. message |
string An error message. |
error. details[] |
object A list of messages that carry the error details. |
response | object includes only one of the fields error , response 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. |