Getting CAPTCHA details

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder used by default is the one specified when creating the CLI profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also specify a different folder for any command using --folder-name or --folder-id. If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

1. See the description of the CLI command for viewing CAPTCHA details:

   yc smartcaptcha captcha get --help
   

2. Getting a list of available 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 CAPTCHA details by running the CLI command with its name or ID specified:

   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 guides on the Terraform website or its mirror.

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

To manage infrastructure using Terraform under a service account or user accounts (a Yandex account, a federated account, or a local user), authenticate using the appropriate method.

To get CAPTCHA details 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 identifier.
   • output "ref_description": Output variable with the client key (client_key) details:
     • value: Return value.

   You can replace client_key with another variable to get the information you need. For more on the properties of the yandex_smartcaptcha_captcha data source, see this provider guide.

2. Create the resources:

   1. In the terminal, navigate to the configuration file directory.

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

      terraform validate
      

      If the configuration is valid, you will get this message:

      Success! The configuration is valid.
      

   3. Run this command:

      terraform plan
      

      You will see a list of resources and their properties. No changes will be made at this step. Terraform will show any errors in the configuration.

   4. Apply the configuration changes:

      terraform apply
      

   5. Type yes and press Enter to confirm the changes.

   Terraform will create all required resources and display their output variables. To check the results, run this command:

   terraform output
   

   Result:

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

To get CAPTCHA details, use the get REST API method for the Captcha resource or the CaptchaService/Get gRPC API call.