Updating the condition format in the API, CLI, and Terraform

Earlier, multiple values in the host condition were provided as a list. Must now be entered in a single text field, separated by |.

The hosts field is also renamed to host_matcher.

Updating current configurationsUpdating current configurations

All rules created in the old format will be automatically migrated to the new format. Your current settings will continue to apply correctly.

Condition description format {matching-format}Condition description format

If the old configuration uses different condition types for this field, combine them into a regular expression.

Example of different condition types in the old format:

exact_match = example.com
exact_not_match = example.net

Example of combining conditions in the new format:

"pireRegexMatch": "example\.com|~(example\.net)"

If special characters, such as (, ), {, }, [, ], ., *, +, ?, ^, $, |, \, &, or ~ are used as regular characters, escape them with \.

You can use ~ as logical negation.

CLI updateCLI update

1. Update the CLI to the latest version:

   yc components update
   

2. View the new field format in the create and update commands:

   yc smartcaptcha captcha create -h
   yc smartcaptcha captcha update -h
   

Examples of using the new fieldExamples of using the new field

  yc smartcaptcha captcha create \
  --name captcha \
  --security-rules '[
    {
      name = "captcha-rule",
      priority = 1,
      condition = {
        host = {
          host-matcher = {
            match = {
              pire-regex-match = "example.com|example.net"
            }
          }
        }
      }
    }
  ]'

resource "yandex_smartcaptcha_captcha" "yandex-smartcaptcha-captcha" {
  name = "test-terraform-yandex-smartcaptcha-captcha"
  security_rule {
    name = "rule-condition-migration"
    priority = 1
    condition {
      host {
        host_matcher {
          pire_regex_match = "a|b"
        }
      }
    }
  }
}

curl -X POST \
  'https://smartcaptcha.api.cloud.yandex.net/smartcaptcha/v1/captchas' \
  -H "Authorization: Bearer $(yc iam create-token)" \
  -H 'Content-Type: application/json' \
  -d '{
    "folderId": "<folder_ID>",
    "name": "captcha",
    "securityRules": [
      {
        "name": "captcha-rule",
        "priority": 1,
        "condition": {
          "host": {
            "hostMatcher": {
              "pireRegexMatch": "a|b"
            }
          }
        }
      }
    ]
  }'

Useful linksUseful links

• Creating a CAPTCHA
• Getting CAPTCHA details
• Verifying the CAPTCHA response