Contact UsGet started
© 2024 Iron Hive LLC Belgrade

SmartWebSecurity API, REST: SecurityProfile.List

Written by
Updated at October 17, 2024

Retrieves the list of SecurityProfile resources in the specified folder.

HTTP request

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

Query parameters

Field

Description

folderId

string

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": "string",
      "name": "string",
      "description": "string",
      "defaultAction": "string",
      "securityRules": [
        {
          "name": "string",
          "priority": "string",
          "dryRun": "boolean",
          // 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`
                    "exactMatch": "string",
                    "exactNotMatch": "string",
                    "prefixMatch": "string",
                    "prefixNotMatch": "string",
                    "pireRegexMatch": "string",
                    "pireRegexNotMatch": "string"
                    // end of the list of possible fields
                  }
                ]
              },
              "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
                  }
                ]
              },
              "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
                },
                "queries": [
                  {
                    "key": "string",
                    "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
                    }
                  }
                ]
              },
              "headers": [
                {
                  "name": "string",
                  "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
                  }
                }
              ],
              "sourceIp": {
                "ipRangesMatch": {
                  "ipRanges": [
                    "string"
                  ]
                },
                "ipRangesNotMatch": {
                  "ipRanges": [
                    "string"
                  ]
                },
                "geoIpMatch": {
                  "locations": [
                    "string"
                  ]
                },
                "geoIpNotMatch": {
                  "locations": [
                    "string"
                  ]
                }
              }
            }
          },
          "smartProtection": {
            "mode": "string",
            "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
                  }
                ]
              },
              "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
                  }
                ]
              },
              "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
                },
                "queries": [
                  {
                    "key": "string",
                    "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
                    }
                  }
                ]
              },
              "headers": [
                {
                  "name": "string",
                  "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
                  }
                }
              ],
              "sourceIp": {
                "ipRangesMatch": {
                  "ipRanges": [
                    "string"
                  ]
                },
                "ipRangesNotMatch": {
                  "ipRanges": [
                    "string"
                  ]
                },
                "geoIpMatch": {
                  "locations": [
                    "string"
                  ]
                },
                "geoIpNotMatch": {
                  "locations": [
                    "string"
                  ]
                }
              }
            }
          },
          "waf": {
            "mode": "string",
            "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
                  }
                ]
              },
              "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
                  }
                ]
              },
              "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
                },
                "queries": [
                  {
                    "key": "string",
                    "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
                    }
                  }
                ]
              },
              "headers": [
                {
                  "name": "string",
                  "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
                  }
                }
              ],
              "sourceIp": {
                "ipRangesMatch": {
                  "ipRanges": [
                    "string"
                  ]
                },
                "ipRangesNotMatch": {
                  "ipRanges": [
                    "string"
                  ]
                },
                "geoIpMatch": {
                  "locations": [
                    "string"
                  ]
                },
                "geoIpNotMatch": {
                  "locations": [
                    "string"
                  ]
                }
              }
            },
            "wafProfileId": "string"
          },
          // end of the list of possible fields
          "description": "string"
        }
      ],
      "createdAt": "string",
      "cloudId": "string",
      "captchaId": "string",
      "advancedRateLimiterProfileId": "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

string

Labels as key:value pairs. Maximum of 64 per resource.

name

string

Required field. 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

enum (DefaultAction)

Required field. Action to perform if none of rules matched.

  • DEFAULT_ACTION_UNSPECIFIED
  • 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.

SecurityRule

A SecurityRule object, see Rules.

Field

Description

name

string

Required field. Name of the rule. The name is unique within the security profile. 1-50 characters long.

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.

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.

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.

description

string

Optional description of the rule. 0-512 characters long.

RuleCondition

RuleCondition object.

Field

Description

action

enum (Action)

Action to perform if this rule matched.

  • ACTION_UNSPECIFIED
  • 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.

sourceIp

IpMatcher

Match IP.

AuthorityMatcher

AuthorityMatcher object.

Field

Description

authorities[]

StringMatcher

List of authorities. OR semantics implied.

StringMatcher

StringMatcher object.

Field

Description

exactMatch

string

Includes only one of the fields exactMatch, exactNotMatch, prefixMatch, prefixNotMatch, pireRegexMatch, pireRegexNotMatch.

exactNotMatch

string

Includes only one of the fields exactMatch, exactNotMatch, prefixMatch, prefixNotMatch, pireRegexMatch, pireRegexNotMatch.

prefixMatch

string

Includes only one of the fields exactMatch, exactNotMatch, prefixMatch, prefixNotMatch, pireRegexMatch, pireRegexNotMatch.

prefixNotMatch

string

Includes only one of the fields exactMatch, exactNotMatch, prefixMatch, prefixNotMatch, pireRegexMatch, pireRegexNotMatch.

pireRegexMatch

string

Includes only one of the fields exactMatch, exactNotMatch, prefixMatch, prefixNotMatch, pireRegexMatch, pireRegexNotMatch.

pireRegexNotMatch

string

Includes only one of the fields exactMatch, exactNotMatch, prefixMatch, prefixNotMatch, pireRegexMatch, pireRegexNotMatch.

HttpMethodMatcher

HttpMethodMatcher object.

Field

Description

httpMethods[]

StringMatcher

List of HTTP methods. OR semantics implied.

RequestUriMatcher

RequestUriMatcher object. AND semantics implied.

Field

Description

path

StringMatcher

Path of the URI RFC3986.

queries[]

QueryMatcher

List of query matchers. AND semantics implied.

QueryMatcher

QueryMatcher object.

Field

Description

key

string

Required field. Key of the query parameter.

value

StringMatcher

Required field. Value of the query parameter.

HeaderMatcher

HeaderMatcher object.

Field

Description

name

string

Required field. Name of header (case insensitive).

value

StringMatcher

Required field. Value of the header.

IpMatcher

IpMatcher object. AND semantics implied.

Field

Description

ipRangesMatch

IpRangesMatcher

ipRangesNotMatch

IpRangesMatcher

geoIpMatch

GeoIpMatcher

geoIpNotMatch

GeoIpMatcher

IpRangesMatcher

IpRangesMatcher object.

Field

Description

ipRanges[]

string

List of IP ranges. OR semantics implied.

GeoIpMatcher

GeoIpMatcher object.

Field

Description

locations[]

string

ISO 3166-1 alpha 2. OR semantics implied.

SmartProtection

SmartProtection object.

Field

Description

mode

enum (Mode)

Mode of protection.

  • MODE_UNSPECIFIED
  • 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)

Mode of protection.

  • MODE_UNSPECIFIED
  • 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.
Previous
Get
Next
Create