SmartWebSecurity API, REST: SecurityProfile.List

Written by

Updated at May 28, 2026

HTTP request
Query parameters
Response
SecurityProfile
SecurityRule
RuleCondition
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
SmartProtection
Waf
AnalyzeRequestBody
LogOptions

Retrieves the list of SecurityProfile resources in the specified folder.

HTTP request

GET https://smartwebsecurity.api.cloud.yandex.net/smartwebsecurity/v1/securityProfiles

Required field. ID of the folder that the security profile belongs to.
Currently page_size, page_token, filter and order_by are not supported and List method will return all security profiles in the folder.

Response

HTTP Code: 200 - OK

{
  "securityProfiles": [
    {
      "id": "string",
      "folderId": "string",
      "labels": "object",
      "name": "string",
      "description": "string",
      "defaultAction": "string",
      "securityRules": [
        {
          // Includes only one of the fields `ruleCondition`, `smartProtection`, `waf`
          "ruleCondition": {
            "action": "string",
            "condition": {
              "authority": {
                "authorities": [
                  {
                    // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                    "exactMatch": "string",
                    "exactNotMatch": "string",
                    "prefixMatch": "string",
                    "prefixNotMatch": "string",
                    "pireRegexMatch": "string",
                    "pireRegexNotMatch": "string",
                    "defined": "boolean",
                    "listsMatchers": {
                      "strListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "strListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      }
                    }
                    // end of the list of possible fields
                  }
                ],
                "authorityMatcher": {
                  // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                  "exactMatch": "string",
                  "exactNotMatch": "string",
                  "prefixMatch": "string",
                  "prefixNotMatch": "string",
                  "pireRegexMatch": "string",
                  "pireRegexNotMatch": "string",
                  "defined": "boolean",
                  "listsMatchers": {
                    "strListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "strListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    }
                  }
                  // end of the list of possible fields
                }
              },
              "httpMethod": {
                "httpMethods": [
                  {
                    // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                    "exactMatch": "string",
                    "exactNotMatch": "string",
                    "prefixMatch": "string",
                    "prefixNotMatch": "string",
                    "pireRegexMatch": "string",
                    "pireRegexNotMatch": "string",
                    "defined": "boolean",
                    "listsMatchers": {
                      "strListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "strListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      }
                    }
                    // end of the list of possible fields
                  }
                ],
                "httpMethodMatcher": {
                  // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                  "exactMatch": "string",
                  "exactNotMatch": "string",
                  "prefixMatch": "string",
                  "prefixNotMatch": "string",
                  "pireRegexMatch": "string",
                  "pireRegexNotMatch": "string",
                  "defined": "boolean",
                  "listsMatchers": {
                    "strListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "strListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    }
                  }
                  // end of the list of possible fields
                }
              },
              "requestUri": {
                "path": {
                  // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                  "exactMatch": "string",
                  "exactNotMatch": "string",
                  "prefixMatch": "string",
                  "prefixNotMatch": "string",
                  "pireRegexMatch": "string",
                  "pireRegexNotMatch": "string",
                  "defined": "boolean",
                  "listsMatchers": {
                    "strListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "strListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    }
                  }
                  // end of the list of possible fields
                },
                "queries": [
                  {
                    "key": "string",
                    "value": {
                      // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                      "exactMatch": "string",
                      "exactNotMatch": "string",
                      "prefixMatch": "string",
                      "prefixNotMatch": "string",
                      "pireRegexMatch": "string",
                      "pireRegexNotMatch": "string",
                      "defined": "boolean",
                      "listsMatchers": {
                        "strListsMatch": {
                          "listIds": [
                            "string"
                          ]
                        },
                        "strListsNotMatch": {
                          "listIds": [
                            "string"
                          ]
                        },
                        "regExpListsMatch": {
                          "listIds": [
                            "string"
                          ]
                        },
                        "regExpListsNotMatch": {
                          "listIds": [
                            "string"
                          ]
                        }
                      }
                      // end of the list of possible fields
                    }
                  }
                ]
              },
              "headers": [
                {
                  "name": "string",
                  "value": {
                    // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                    "exactMatch": "string",
                    "exactNotMatch": "string",
                    "prefixMatch": "string",
                    "prefixNotMatch": "string",
                    "pireRegexMatch": "string",
                    "pireRegexNotMatch": "string",
                    "defined": "boolean",
                    "listsMatchers": {
                      "strListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "strListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      }
                    }
                    // end of the list of possible fields
                  }
                }
              ],
              "sourceIp": {
                "ipRangesMatch": {
                  "ipRanges": [
                    "string"
                  ]
                },
                "ipRangesNotMatch": {
                  "ipRanges": [
                    "string"
                  ]
                },
                "geoIpMatch": {
                  "locations": [
                    "string"
                  ]
                },
                "geoIpNotMatch": {
                  "locations": [
                    "string"
                  ]
                },
                "ipListsMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "ipListsNotMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "asnRangesMatch": {
                  "asnRanges": [
                    "string"
                  ]
                },
                "asnRangesNotMatch": {
                  "asnRanges": [
                    "string"
                  ]
                },
                "asnListsMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "asnListsNotMatch": {
                  "listIds": [
                    "string"
                  ]
                }
              },
              "cookies": [
                {
                  "name": "string",
                  "value": {
                    // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                    "exactMatch": "string",
                    "exactNotMatch": "string",
                    "prefixMatch": "string",
                    "prefixNotMatch": "string",
                    "pireRegexMatch": "string",
                    "pireRegexNotMatch": "string",
                    "defined": "boolean",
                    "listsMatchers": {
                      "strListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "strListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      }
                    }
                    // end of the list of possible fields
                  }
                }
              ],
              "botCategory": {
                "botCategoryListsMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "botCategoryListsNotMatch": {
                  "listIds": [
                    "string"
                  ]
                }
              },
              "botName": {
                "botNameListsMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "botNameListsNotMatch": {
                  "listIds": [
                    "string"
                  ]
                }
              },
              "botScore": {
                "value": [
                  {
                    // Includes only one of the fields `leMatch`, `geMatch`, `eqMatch`, `neMatch`
                    "leMatch": {
                      "value": "string"
                    },
                    "geMatch": {
                      "value": "string"
                    },
                    "eqMatch": {
                      "value": "string"
                    },
                    "neMatch": {
                      "value": "string"
                    }
                    // end of the list of possible fields
                  }
                ]
              },
              "verifiedBot": {
                "verified": {
                  "match": "boolean"
                }
              },
              "fingerPrint": {
                "ja3Ranges": [
                  {
                    // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                    "exactMatch": "string",
                    "exactNotMatch": "string",
                    "prefixMatch": "string",
                    "prefixNotMatch": "string",
                    "pireRegexMatch": "string",
                    "pireRegexNotMatch": "string",
                    "defined": "boolean",
                    "listsMatchers": {
                      "strListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "strListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      }
                    }
                    // end of the list of possible fields
                  }
                ],
                "ja4Ranges": [
                  {
                    // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                    "exactMatch": "string",
                    "exactNotMatch": "string",
                    "prefixMatch": "string",
                    "prefixNotMatch": "string",
                    "pireRegexMatch": "string",
                    "pireRegexNotMatch": "string",
                    "defined": "boolean",
                    "listsMatchers": {
                      "strListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "strListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      }
                    }
                    // end of the list of possible fields
                  }
                ],
                "ja3Matcher": {
                  // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                  "exactMatch": "string",
                  "exactNotMatch": "string",
                  "prefixMatch": "string",
                  "prefixNotMatch": "string",
                  "pireRegexMatch": "string",
                  "pireRegexNotMatch": "string",
                  "defined": "boolean",
                  "listsMatchers": {
                    "strListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "strListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    }
                  }
                  // end of the list of possible fields
                },
                "ja4Matcher": {
                  // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                  "exactMatch": "string",
                  "exactNotMatch": "string",
                  "prefixMatch": "string",
                  "prefixNotMatch": "string",
                  "pireRegexMatch": "string",
                  "pireRegexNotMatch": "string",
                  "defined": "boolean",
                  "listsMatchers": {
                    "strListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "strListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    }
                  }
                  // end of the list of possible fields
                }
              }
            }
          },
          "smartProtection": {
            "mode": "string",
            "condition": {
              "authority": {
                "authorities": [
                  {
                    // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                    "exactMatch": "string",
                    "exactNotMatch": "string",
                    "prefixMatch": "string",
                    "prefixNotMatch": "string",
                    "pireRegexMatch": "string",
                    "pireRegexNotMatch": "string",
                    "defined": "boolean",
                    "listsMatchers": {
                      "strListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "strListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      }
                    }
                    // end of the list of possible fields
                  }
                ],
                "authorityMatcher": {
                  // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                  "exactMatch": "string",
                  "exactNotMatch": "string",
                  "prefixMatch": "string",
                  "prefixNotMatch": "string",
                  "pireRegexMatch": "string",
                  "pireRegexNotMatch": "string",
                  "defined": "boolean",
                  "listsMatchers": {
                    "strListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "strListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    }
                  }
                  // end of the list of possible fields
                }
              },
              "httpMethod": {
                "httpMethods": [
                  {
                    // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                    "exactMatch": "string",
                    "exactNotMatch": "string",
                    "prefixMatch": "string",
                    "prefixNotMatch": "string",
                    "pireRegexMatch": "string",
                    "pireRegexNotMatch": "string",
                    "defined": "boolean",
                    "listsMatchers": {
                      "strListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "strListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      }
                    }
                    // end of the list of possible fields
                  }
                ],
                "httpMethodMatcher": {
                  // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                  "exactMatch": "string",
                  "exactNotMatch": "string",
                  "prefixMatch": "string",
                  "prefixNotMatch": "string",
                  "pireRegexMatch": "string",
                  "pireRegexNotMatch": "string",
                  "defined": "boolean",
                  "listsMatchers": {
                    "strListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "strListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    }
                  }
                  // end of the list of possible fields
                }
              },
              "requestUri": {
                "path": {
                  // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                  "exactMatch": "string",
                  "exactNotMatch": "string",
                  "prefixMatch": "string",
                  "prefixNotMatch": "string",
                  "pireRegexMatch": "string",
                  "pireRegexNotMatch": "string",
                  "defined": "boolean",
                  "listsMatchers": {
                    "strListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "strListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    }
                  }
                  // end of the list of possible fields
                },
                "queries": [
                  {
                    "key": "string",
                    "value": {
                      // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                      "exactMatch": "string",
                      "exactNotMatch": "string",
                      "prefixMatch": "string",
                      "prefixNotMatch": "string",
                      "pireRegexMatch": "string",
                      "pireRegexNotMatch": "string",
                      "defined": "boolean",
                      "listsMatchers": {
                        "strListsMatch": {
                          "listIds": [
                            "string"
                          ]
                        },
                        "strListsNotMatch": {
                          "listIds": [
                            "string"
                          ]
                        },
                        "regExpListsMatch": {
                          "listIds": [
                            "string"
                          ]
                        },
                        "regExpListsNotMatch": {
                          "listIds": [
                            "string"
                          ]
                        }
                      }
                      // end of the list of possible fields
                    }
                  }
                ]
              },
              "headers": [
                {
                  "name": "string",
                  "value": {
                    // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                    "exactMatch": "string",
                    "exactNotMatch": "string",
                    "prefixMatch": "string",
                    "prefixNotMatch": "string",
                    "pireRegexMatch": "string",
                    "pireRegexNotMatch": "string",
                    "defined": "boolean",
                    "listsMatchers": {
                      "strListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "strListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      }
                    }
                    // end of the list of possible fields
                  }
                }
              ],
              "sourceIp": {
                "ipRangesMatch": {
                  "ipRanges": [
                    "string"
                  ]
                },
                "ipRangesNotMatch": {
                  "ipRanges": [
                    "string"
                  ]
                },
                "geoIpMatch": {
                  "locations": [
                    "string"
                  ]
                },
                "geoIpNotMatch": {
                  "locations": [
                    "string"
                  ]
                },
                "ipListsMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "ipListsNotMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "asnRangesMatch": {
                  "asnRanges": [
                    "string"
                  ]
                },
                "asnRangesNotMatch": {
                  "asnRanges": [
                    "string"
                  ]
                },
                "asnListsMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "asnListsNotMatch": {
                  "listIds": [
                    "string"
                  ]
                }
              },
              "cookies": [
                {
                  "name": "string",
                  "value": {
                    // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                    "exactMatch": "string",
                    "exactNotMatch": "string",
                    "prefixMatch": "string",
                    "prefixNotMatch": "string",
                    "pireRegexMatch": "string",
                    "pireRegexNotMatch": "string",
                    "defined": "boolean",
                    "listsMatchers": {
                      "strListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "strListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      }
                    }
                    // end of the list of possible fields
                  }
                }
              ],
              "botCategory": {
                "botCategoryListsMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "botCategoryListsNotMatch": {
                  "listIds": [
                    "string"
                  ]
                }
              },
              "botName": {
                "botNameListsMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "botNameListsNotMatch": {
                  "listIds": [
                    "string"
                  ]
                }
              },
              "botScore": {
                "value": [
                  {
                    // Includes only one of the fields `leMatch`, `geMatch`, `eqMatch`, `neMatch`
                    "leMatch": {
                      "value": "string"
                    },
                    "geMatch": {
                      "value": "string"
                    },
                    "eqMatch": {
                      "value": "string"
                    },
                    "neMatch": {
                      "value": "string"
                    }
                    // end of the list of possible fields
                  }
                ]
              },
              "verifiedBot": {
                "verified": {
                  "match": "boolean"
                }
              },
              "fingerPrint": {
                "ja3Ranges": [
                  {
                    // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                    "exactMatch": "string",
                    "exactNotMatch": "string",
                    "prefixMatch": "string",
                    "prefixNotMatch": "string",
                    "pireRegexMatch": "string",
                    "pireRegexNotMatch": "string",
                    "defined": "boolean",
                    "listsMatchers": {
                      "strListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "strListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      }
                    }
                    // end of the list of possible fields
                  }
                ],
                "ja4Ranges": [
                  {
                    // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                    "exactMatch": "string",
                    "exactNotMatch": "string",
                    "prefixMatch": "string",
                    "prefixNotMatch": "string",
                    "pireRegexMatch": "string",
                    "pireRegexNotMatch": "string",
                    "defined": "boolean",
                    "listsMatchers": {
                      "strListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "strListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      }
                    }
                    // end of the list of possible fields
                  }
                ],
                "ja3Matcher": {
                  // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                  "exactMatch": "string",
                  "exactNotMatch": "string",
                  "prefixMatch": "string",
                  "prefixNotMatch": "string",
                  "pireRegexMatch": "string",
                  "pireRegexNotMatch": "string",
                  "defined": "boolean",
                  "listsMatchers": {
                    "strListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "strListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    }
                  }
                  // end of the list of possible fields
                },
                "ja4Matcher": {
                  // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                  "exactMatch": "string",
                  "exactNotMatch": "string",
                  "prefixMatch": "string",
                  "prefixNotMatch": "string",
                  "pireRegexMatch": "string",
                  "pireRegexNotMatch": "string",
                  "defined": "boolean",
                  "listsMatchers": {
                    "strListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "strListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    }
                  }
                  // end of the list of possible fields
                }
              }
            }
          },
          "waf": {
            "mode": "string",
            "condition": {
              "authority": {
                "authorities": [
                  {
                    // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                    "exactMatch": "string",
                    "exactNotMatch": "string",
                    "prefixMatch": "string",
                    "prefixNotMatch": "string",
                    "pireRegexMatch": "string",
                    "pireRegexNotMatch": "string",
                    "defined": "boolean",
                    "listsMatchers": {
                      "strListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "strListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      }
                    }
                    // end of the list of possible fields
                  }
                ],
                "authorityMatcher": {
                  // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                  "exactMatch": "string",
                  "exactNotMatch": "string",
                  "prefixMatch": "string",
                  "prefixNotMatch": "string",
                  "pireRegexMatch": "string",
                  "pireRegexNotMatch": "string",
                  "defined": "boolean",
                  "listsMatchers": {
                    "strListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "strListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    }
                  }
                  // end of the list of possible fields
                }
              },
              "httpMethod": {
                "httpMethods": [
                  {
                    // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                    "exactMatch": "string",
                    "exactNotMatch": "string",
                    "prefixMatch": "string",
                    "prefixNotMatch": "string",
                    "pireRegexMatch": "string",
                    "pireRegexNotMatch": "string",
                    "defined": "boolean",
                    "listsMatchers": {
                      "strListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "strListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      }
                    }
                    // end of the list of possible fields
                  }
                ],
                "httpMethodMatcher": {
                  // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                  "exactMatch": "string",
                  "exactNotMatch": "string",
                  "prefixMatch": "string",
                  "prefixNotMatch": "string",
                  "pireRegexMatch": "string",
                  "pireRegexNotMatch": "string",
                  "defined": "boolean",
                  "listsMatchers": {
                    "strListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "strListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    }
                  }
                  // end of the list of possible fields
                }
              },
              "requestUri": {
                "path": {
                  // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                  "exactMatch": "string",
                  "exactNotMatch": "string",
                  "prefixMatch": "string",
                  "prefixNotMatch": "string",
                  "pireRegexMatch": "string",
                  "pireRegexNotMatch": "string",
                  "defined": "boolean",
                  "listsMatchers": {
                    "strListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "strListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    }
                  }
                  // end of the list of possible fields
                },
                "queries": [
                  {
                    "key": "string",
                    "value": {
                      // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                      "exactMatch": "string",
                      "exactNotMatch": "string",
                      "prefixMatch": "string",
                      "prefixNotMatch": "string",
                      "pireRegexMatch": "string",
                      "pireRegexNotMatch": "string",
                      "defined": "boolean",
                      "listsMatchers": {
                        "strListsMatch": {
                          "listIds": [
                            "string"
                          ]
                        },
                        "strListsNotMatch": {
                          "listIds": [
                            "string"
                          ]
                        },
                        "regExpListsMatch": {
                          "listIds": [
                            "string"
                          ]
                        },
                        "regExpListsNotMatch": {
                          "listIds": [
                            "string"
                          ]
                        }
                      }
                      // end of the list of possible fields
                    }
                  }
                ]
              },
              "headers": [
                {
                  "name": "string",
                  "value": {
                    // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                    "exactMatch": "string",
                    "exactNotMatch": "string",
                    "prefixMatch": "string",
                    "prefixNotMatch": "string",
                    "pireRegexMatch": "string",
                    "pireRegexNotMatch": "string",
                    "defined": "boolean",
                    "listsMatchers": {
                      "strListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "strListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      }
                    }
                    // end of the list of possible fields
                  }
                }
              ],
              "sourceIp": {
                "ipRangesMatch": {
                  "ipRanges": [
                    "string"
                  ]
                },
                "ipRangesNotMatch": {
                  "ipRanges": [
                    "string"
                  ]
                },
                "geoIpMatch": {
                  "locations": [
                    "string"
                  ]
                },
                "geoIpNotMatch": {
                  "locations": [
                    "string"
                  ]
                },
                "ipListsMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "ipListsNotMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "asnRangesMatch": {
                  "asnRanges": [
                    "string"
                  ]
                },
                "asnRangesNotMatch": {
                  "asnRanges": [
                    "string"
                  ]
                },
                "asnListsMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "asnListsNotMatch": {
                  "listIds": [
                    "string"
                  ]
                }
              },
              "cookies": [
                {
                  "name": "string",
                  "value": {
                    // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                    "exactMatch": "string",
                    "exactNotMatch": "string",
                    "prefixMatch": "string",
                    "prefixNotMatch": "string",
                    "pireRegexMatch": "string",
                    "pireRegexNotMatch": "string",
                    "defined": "boolean",
                    "listsMatchers": {
                      "strListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "strListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      }
                    }
                    // end of the list of possible fields
                  }
                }
              ],
              "botCategory": {
                "botCategoryListsMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "botCategoryListsNotMatch": {
                  "listIds": [
                    "string"
                  ]
                }
              },
              "botName": {
                "botNameListsMatch": {
                  "listIds": [
                    "string"
                  ]
                },
                "botNameListsNotMatch": {
                  "listIds": [
                    "string"
                  ]
                }
              },
              "botScore": {
                "value": [
                  {
                    // Includes only one of the fields `leMatch`, `geMatch`, `eqMatch`, `neMatch`
                    "leMatch": {
                      "value": "string"
                    },
                    "geMatch": {
                      "value": "string"
                    },
                    "eqMatch": {
                      "value": "string"
                    },
                    "neMatch": {
                      "value": "string"
                    }
                    // end of the list of possible fields
                  }
                ]
              },
              "verifiedBot": {
                "verified": {
                  "match": "boolean"
                }
              },
              "fingerPrint": {
                "ja3Ranges": [
                  {
                    // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                    "exactMatch": "string",
                    "exactNotMatch": "string",
                    "prefixMatch": "string",
                    "prefixNotMatch": "string",
                    "pireRegexMatch": "string",
                    "pireRegexNotMatch": "string",
                    "defined": "boolean",
                    "listsMatchers": {
                      "strListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "strListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      }
                    }
                    // end of the list of possible fields
                  }
                ],
                "ja4Ranges": [
                  {
                    // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                    "exactMatch": "string",
                    "exactNotMatch": "string",
                    "prefixMatch": "string",
                    "prefixNotMatch": "string",
                    "pireRegexMatch": "string",
                    "pireRegexNotMatch": "string",
                    "defined": "boolean",
                    "listsMatchers": {
                      "strListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "strListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsMatch": {
                        "listIds": [
                          "string"
                        ]
                      },
                      "regExpListsNotMatch": {
                        "listIds": [
                          "string"
                        ]
                      }
                    }
                    // end of the list of possible fields
                  }
                ],
                "ja3Matcher": {
                  // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                  "exactMatch": "string",
                  "exactNotMatch": "string",
                  "prefixMatch": "string",
                  "prefixNotMatch": "string",
                  "pireRegexMatch": "string",
                  "pireRegexNotMatch": "string",
                  "defined": "boolean",
                  "listsMatchers": {
                    "strListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "strListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    }
                  }
                  // end of the list of possible fields
                },
                "ja4Matcher": {
                  // Includes only one of the fields `exactMatch`, `exactNotMatch`, `prefixMatch`, `prefixNotMatch`, `pireRegexMatch`, `pireRegexNotMatch`, `defined`, `listsMatchers`
                  "exactMatch": "string",
                  "exactNotMatch": "string",
                  "prefixMatch": "string",
                  "prefixNotMatch": "string",
                  "pireRegexMatch": "string",
                  "pireRegexNotMatch": "string",
                  "defined": "boolean",
                  "listsMatchers": {
                    "strListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "strListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsMatch": {
                      "listIds": [
                        "string"
                      ]
                    },
                    "regExpListsNotMatch": {
                      "listIds": [
                        "string"
                      ]
                    }
                  }
                  // end of the list of possible fields
                }
              }
            },
            "wafProfileId": "string"
          },
          // end of the list of possible fields
          "name": "string",
          "priority": "string",
          "dryRun": "boolean",
          "description": "string",
          "customPageId": "string"
        }
      ],
      "createdAt": "string",
      "cloudId": "string",
      "captchaId": "string",
      "advancedRateLimiterProfileId": "string",
      "disallowDataProcessing": "boolean",
      "analyzeRequestBody": {
        "sizeLimit": "string",
        "sizeLimitAction": "string"
      },
      "logOptions": {
        "logGroupId": "string",
        "enable": "boolean",
        "enabledModules": [
          "string"
        ],
        "enabledActions": [
          "string"
        ],
        "discardAllowPercentage": "string",
        "outputs": [
          "string"
        ]
      },
      "logGroupId": "string",
      "customPageId": "string"
    }
  ]
}

Field

Description

securityProfiles[]

SecurityProfile

List of SecurityProfile resources.
Currently next_page_token is not supported and List method will return all security profiles in the folder.

SecurityProfile

A SecurityProfile resource.

Field	Description
id	string ID of the security profile.
folderId	string ID of the folder that the security profile belongs to.
labels	object (map<string, string>) Labels as `key:value` pairs. Maximum of 64 per resource. 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 `[a-z][-_0-9a-z]`. Each value must match the regular expression `[-_0-9a-z]`. No more than 64 per resource.
name	string Name of the security profile. The name is unique within the folder. 1-50 characters long. The string length in characters must be 1-50. Value must match the regular expression `[a-zA-Z0-9][a-zA-Z0-9-_.]*`.
description	string Optional description of the security profile. The maximum string length in characters is 512.
defaultAction	enum (DefaultAction) Required field. Action to perform if none of rules matched. `ALLOW`: Pass request to service. `DENY`: Deny request.
securityRules[]	SecurityRule List of security rules.
createdAt	string (date-time) Creation timestamp in RFC3339 text format. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
cloudId	string ID of the cloud that the security profile belongs to.
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.
disallowDataProcessing	boolean Disables the use of HTTP request data for training and improving the service's ML models.
analyzeRequestBody	AnalyzeRequestBody Parameters for request body analyzer.
logOptions	LogOptions Configures logging of requests processed by SWS to Audit Trails and Cloud Logging.
logGroupId	string ID of the Cloud Logging log group to write SWS logs to.
customPageId	string ID of the default custom page shown to the user when a request is denied.

SecurityRule

A SecurityRule object, see Rules.

Field	Description
ruleCondition	RuleCondition Rule actions, see Rule actions. Includes only one of the fields `ruleCondition`, `smartProtection`, `waf`.
smartProtection	SmartProtection Smart Protection rule, see Smart Protection rules. Includes only one of the fields `ruleCondition`, `smartProtection`, `waf`.
waf	Waf Web Application Firewall (WAF) rule, see WAF rules. Includes only one of the fields `ruleCondition`, `smartProtection`, `waf`.
name	string Required field. 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 `[a-zA-Z0-9][a-zA-Z0-9-_.]*`.
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.
dryRun	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.
description	string Optional description of the rule. 0-512 characters long. The maximum string length in characters is 512.
customPageId	string ID of the custom page shown to the user when the rule denies a request.

RuleCondition

RuleCondition object.

Field

Description

action

enum (Action)

Required field. Action to perform if this rule matched.

ALLOW: Pass request to service.
DENY: Deny request.

condition

Condition

The condition for matching the rule.

Condition

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

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

AuthorityMatcher

AuthorityMatcher object.

Field

Description

authorities[]

StringMatcher

List of authorities. OR semantics implied.

The maximum number of elements is 20.

authorityMatcher

StringMatcher

Authority matcher.

StringMatcher

StringMatcher object.

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

ListsMatchers

ListsMatchers object.

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

ListsMatcher

ListsMatcher object.

Field

Description

listIds[]

string

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

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

HttpMethodMatcher

HttpMethodMatcher object.

Field

Description

httpMethods[]

StringMatcher

List of HTTP methods. OR semantics implied.

The maximum number of elements is 20.

httpMethodMatcher

StringMatcher

HTTP method matcher.

RequestUriMatcher

RequestUriMatcher object. AND semantics implied.

Field

Description

path

StringMatcher

Path of the URI RFC3986.

queries[]

QueryMatcher

List of query matchers. AND semantics implied.

The maximum number of elements is 20.

QueryMatcher

QueryMatcher object.

Field

Description

key

string

Required field. Key of the query parameter.

The string length in characters must be 1-255.

value

StringMatcher

Required field. Value of the query parameter.

HeaderMatcher

HeaderMatcher object.

Field

Description

name

string

Required field. Name of header (case insensitive).

The string length in characters must be 1-255.

value

StringMatcher

Required field. Value of the header.

IpMatcher

IpMatcher object. AND semantics implied.

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

IpRangesMatcher

IpRangesMatcher object.

Field

Description

ipRanges[]

string

List of IP ranges. OR semantics implied.

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

GeoIpMatcher

GeoIpMatcher object.

Field

Description

locations[]

string

ISO 3166-1 alpha 2. OR semantics implied.

The minimum number of elements is 1.

AsnRangesMatcher

AsnRangesMatcher object.

Field

Description

asnRanges[]

string (int64)

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

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

CookieMatcher

CookieMatcher object.

Field

Description

name

string

Required field. Name of the cookie parametr.

The string length in characters must be 1-255.

value

StringMatcher

Required field. Value of the cookie parametr.

BotCategoryMatcher

BotCategoryMatcher object. AND semantics implied.

Field

Description

botCategoryListsMatch

ListsMatcher

Bot category lists to match with.

botCategoryListsNotMatch

ListsMatcher

Bot category lists to not match with.

BotNameMatcher

BotNameMatcher object. AND semantics implied.

Field

Description

botNameListsMatch

ListsMatcher

Bot name lists to match with.

botNameListsNotMatch

ListsMatcher

Bot name lists to not match with.

BotScoreMatcher

BotScoreMatcher object.

Field

Description

value[]

IntMatcher

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

The maximum number of elements is 4.

IntMatcher

IntMatcher object.

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

IntLEMatcher

IntLEMatcher object.

Field

Description

value

string (int64)

Upper bound value (inclusive).

IntGEMatcher

IntGEMatcher object.

Field

Description

value

string (int64)

Lower bound value (inclusive).

IntEQMatcher

IntEQMatcher object.

Field

Description

value

string (int64)

Value to match against.

IntNEMatcher

IntNEMatcher object.

Field

Description

value

string (int64)

Value to not match against.

VerifiedBotMatcher

VerifiedBotMatcher object.

Field

Description

verified

BoolMatcher

Matches if the bot is verified or not.

BoolMatcher

BoolMatcher object.

Field

Description

match

boolean

Boolean value to match against.

FingerPrintMatcher

FingerPrintMatcher object.

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

SmartProtection

SmartProtection object.

Field

Description

mode

enum (Mode)

Required field. Mode of protection.

FULL: Full protection means that the traffic will be checked based on ML models and behavioral analysis,
with suspicious requests being sent to SmartCaptcha.
API: API protection means checking the traffic based on ML models and behavioral analysis without sending suspicious
requests to SmartCaptcha. The suspicious requests will be blocked.

condition

Condition

The condition for matching the rule.

Waf

Waf object.

Field	Description
mode	enum (Mode) Required field. Mode of protection. `FULL`: Full protection means that the traffic will be checked based on ML models and behavioral analysis, with suspicious requests being sent to SmartCaptcha. `API`: API protection means checking the traffic based on ML models and behavioral analysis without sending suspicious requests to SmartCaptcha. The suspicious requests will be blocked.
condition	Condition The condition for matching the rule.
wafProfileId	string Required field. ID of WAF profile to use in this rule.

AnalyzeRequestBody

Field

Description

sizeLimit

string (int64)

Maximum size of body to pass to analyzer. In kilobytes.

sizeLimitAction

enum (Action)

Required field. Action to perform if maximum size of body exceeded.

IGNORE: Ignore body.
DENY: Deny request.

LogOptions

Field	Description
logGroupId	string ID of the Cloud Logging log group to write SWS logs to.
enable	boolean Enables logging of requests processed by SWS.
enabledModules[]	enum (Module) List of modules whose requests will be logged. `RULE_CONDITION`: Base rules condition check. `SMART_PROTECTION`: Smart Protection module. `WAF`: Web Application Firewall module. `ARL`: Advanced Rate Limiter module.
enabledActions[]	enum (Action) List of verdicts for which requests will be logged. `ALLOW`: Request was allowed. `DENY`: Request was denied. `CAPTCHA`: Request was redirected to CAPTCHA.
discardAllowPercentage	string (int64) Percentage of ALLOW verdicts to discard from logging (0-100). Acceptable values are 0 to 100, inclusive.
outputs[]	enum (Output) List of log destinations: Cloud Logging and/or Audit Trails. `CLOUD_LOGGING`: Write logs to Cloud Logging. `AUDIT_TRAILS`: Write logs to Audit Trails.

SmartWebSecurity API, REST: SecurityProfile.List

HTTP requestHTTP request

Query parametersQuery parameters

ResponseResponse

SecurityProfileSecurityProfile

SecurityRuleSecurityRule

RuleConditionRuleCondition

ConditionCondition

AuthorityMatcherAuthorityMatcher

StringMatcherStringMatcher

ListsMatchersListsMatchers

ListsMatcherListsMatcher

HttpMethodMatcherHttpMethodMatcher

RequestUriMatcherRequestUriMatcher

QueryMatcherQueryMatcher

HeaderMatcherHeaderMatcher

IpMatcherIpMatcher

IpRangesMatcherIpRangesMatcher

GeoIpMatcherGeoIpMatcher

AsnRangesMatcherAsnRangesMatcher

CookieMatcherCookieMatcher

BotCategoryMatcherBotCategoryMatcher

BotNameMatcherBotNameMatcher

BotScoreMatcherBotScoreMatcher

IntMatcherIntMatcher

IntLEMatcherIntLEMatcher

IntGEMatcherIntGEMatcher

IntEQMatcherIntEQMatcher

IntNEMatcherIntNEMatcher

VerifiedBotMatcherVerifiedBotMatcher

BoolMatcherBoolMatcher

FingerPrintMatcherFingerPrintMatcher

SmartProtectionSmartProtection

WafWaf

AnalyzeRequestBodyAnalyzeRequestBody

LogOptionsLogOptions

Was the article helpful?

HTTP request

Query parameters

Response

SecurityProfile

SecurityRule

RuleCondition

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

SmartProtection

Waf

AnalyzeRequestBody

LogOptions