Getting information about a CAPTCHA

If you do not have the Yandex Cloud (CLI) command line interface yet, install and initialize it.

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.

1. See the description of the CLI command to view information about a CAPTCHA:

   yc smartcaptcha captcha get --help
   

2. Get a list of captchas:

   yc smartcaptcha captcha list
   

   Result:

   +----------------------+---------+---------------------+------------+----------------+----------------+-------------+
   |          ID          |  NAME   |       CREATED       | COMPLEXITY | PRE-CHECK TYPE | CHALLENGE TYPE | RULES COUNT |
   +----------------------+---------+---------------------+------------+----------------+----------------+-------------+
   | bpne29ifsca8******** | test    | 2025-02-24 17:16:13 | MEDIUM     | CHECKBOX       | IMAGE_TEXT     |           0 |
   | bpnm7lhokq2t******** | prod    | 2025-02-26 09:12:02 | MEDIUM     | CHECKBOX       | IMAGE_TEXT     |           0 |
   | bpn43btuo4g9******** | website | 2025-02-26 09:12:42 | MEDIUM     | CHECKBOX       | IMAGE_TEXT     |           0 |
   +----------------------+---------+---------------------+------------+----------------+----------------+-------------+
   

3. Get detailed information about a CAPTCHA by specifying its name or ID:

   yc smartcaptcha captcha get <captcha_ID>
   

   Result:

   id: bpne29ifsca8********
   folder_id: b1geoelk7fld********
   cloud_id: b1gia87mbaom********
   client_key: ysc1_MtyvvAUieCSUfHb6tugqFAbTyesgGzXWU50sZq0E********
   created_at: "2025-02-24T17:16:13.034742Z"
   name: test
   allowed_sites:
    - example.com
   complexity: MEDIUM
   pre_check_type: CHECKBOX
   challenge_type: IMAGE_TEXT
   

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. These files store the infrastructure description written in HashiCorp Configuration Language (HCL). If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

For more information about the provider resources, see the documentation on the Terraform website or mirror website.

If you do not have Terraform yet, install it and configure its Yandex Cloud provider.

To get information about a CAPTCHA using Terraform:

1. Add the data and output sections to the Terraform configuration file:

   data "yandex_smartcaptcha_captcha" "my-captcha" {
     captcha_id = "<captcha_ID>"
   }
   
   output "my-client-key" {
     value = data.yandex_smartcaptcha_captcha.my-captcha.client_key
   }
   

   Where:

   • data "yandex_smartcaptcha_captcha": Description of the CAPTCHA as a data source:
     • resource_id: Resource ID.
   • output "ref_description": Output variable with information about the client key (client_key):
     • value: Returned value.

   You can replace client_key with any other parameter to get the information you need. For more information about the yandex_smartcaptcha_captcha data source parameters, see the relevant provider documentation.

2. Create the resources:

   1. In the terminal, change to the folder where you edited the configuration file.

   2. Make sure the configuration file is correct using the command:

      terraform validate
      

      If the configuration is correct, the following message is returned:

      Success! The configuration is valid.
      

   3. Run the command:

      terraform plan
      

      The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.

   4. Apply the configuration changes:

      terraform apply
      

   5. Confirm the changes: type yes in the terminal and press Enter.

   Terraform will create all the required resources and display the output variable values in the terminal. To check the results, run this command:

   terraform output
   

   Result:

   my-client-key = ysc1_MtyvvAUieCSUfHb6tugqFAbTyesgGzXWU50sZq0E********
   ...
   

To get detailed information about a CAPTCHA, use the get REST API method for the Captcha resource or the CaptchaService/Get gRPC API call.