yc smartcaptcha captcha create

Статья создана

Обновлена 2 апреля 2026 г.

Creates a captcha in the specified folder using the data specified in the request.

Command Usage

Syntax:

yc smartcaptcha captcha create <FOLDER-ID>

Flags

Flag	Description
`-r`, `--request-file`	`string` Path to a request file.
`--example-json`	Generates a JSON template of the request. The template can be customized and used as input for the command. Usage example: Generate template: yc compute instance create --example-json > request.json Edit the template: vim request.json Run with template: yc compute instance create -r request.json
`--example-yaml`	Generates a YAML template of the request. The template can be customized and used as input for the command. Usage example: Generate template: yc compute instance create --example-yaml > request.yaml Edit the template: vim request.yaml Run with template: yc compute instance create -r request.yaml
`--allowed-sites`	`[]string` List of allowed host names, see documentation.
`--challenge-type`	`enum` Additional task type of the captcha. Possible Values: 'image-text', 'silhouettes', 'kaleidoscope'
`--complexity`	`enum` Complexity of the captcha. Possible Values: 'easy', 'medium', 'hard', 'force-hard'
`--deletion-protection`	Determines whether captcha is protected from being deleted.
`--description`	`string` Optional description of the captcha.
`--disallow-data-processing`	If true, Yandex team won't be able to read internal data.
`--folder-id`	`string` ID of the folder to create a captcha in.
`--labels`	`map<string><string>` Resource labels as 'key:value' pairs.
`--name`	`string` Name of the captcha. The name must be unique within the folder.
`--override-variants`	`shorthand/json` List of variants to use in security_rules Description challenge-type (structure) Additional task type of the captcha. complexity (structure) Complexity of the captcha. description (string) Optional description of the rule. 0-512 characters long. pre-check-type (structure) Basic check type of the captcha. uuid (string) Unique identifier of the variant. Shorthand Syntax `[ { challenge-type = IMAGE_TEXT\|SILHOUETTES\|KALEIDOSCOPE, complexity = EASY\|MEDIUM\|HARD\|FORCE_HARD, description = string, pre-check-type = CHECKBOX\|SLIDER, uuid = string }, ... ]` JSON Syntax `[ { "challenge-type": "IMAGE_TEXT\|SILHOUETTES\|KALEIDOSCOPE", "complexity": "EASY\|MEDIUM\|HARD\|FORCE_HARD", "description": "string", "pre-check-type": "CHECKBOX\|SLIDER", "uuid": "string" }, ... ]`
`--pre-check-type`	`enum` Basic check type of the captcha. Possible Values: 'checkbox', 'slider'
`--security-rules`	`shorthand/json` List of security rules. Description condition (structure) The condition for matching the rule. headers ([]structure) Captcha request headers. name (string) Name of header (case insensitive). value (structure) Value of the header. match (oneof) Oneof match field exact-match (string) Exact match condition. exact-not-match (string) Exact not match condition. prefix-match (string) Prefix match condition. prefix-not-match (string) Prefix not match condition. pire-regex-match (string) PIRE regex match condition. pire-regex-not-match (string) PIRE regex not match condition. host (structure) AND semantics implied. host-matcher (structure) Host matcher. match (oneof) Oneof match field exact-match (string) Exact match condition. exact-not-match (string) Exact not match condition. prefix-match (string) Prefix match condition. prefix-not-match (string) Prefix not match condition. pire-regex-match (string) PIRE regex match condition. pire-regex-not-match (string) PIRE regex not match condition. hosts ([]structure) List of hosts. OR semantics implied. match (oneof) Oneof match field exact-match (string) Exact match condition. exact-not-match (string) Exact not match condition. prefix-match (string) Prefix match condition. prefix-not-match (string) Prefix not match condition. pire-regex-match (string) PIRE regex match condition. pire-regex-not-match (string) PIRE regex not match condition. source-ip (structure) The IP address of the requester. geo-ip-match (structure) Geo locations to match with. locations ([]string) OR semantics implied. ISO 3166-1 alpha 2 geo-ip-not-match (structure) Geo locations to not match with. locations ([]string) OR semantics implied. ISO 3166-1 alpha 2 ip-ranges-match (structure) IP ranges to match with. ip-ranges ([]string) OR semantics implied. ip-ranges-not-match (structure) IP ranges to not match with. ip-ranges ([]string) OR semantics implied. uri (structure) URI where captcha placed. path (structure) Path of the URI RFC3986. match (oneof) Oneof match field exact-match (string) Exact match condition. exact-not-match (string) Exact not match condition. prefix-match (string) Prefix match condition. prefix-not-match (string) Prefix not match condition. pire-regex-match (string) PIRE regex match condition. pire-regex-not-match (string) PIRE regex not match condition. queries ([]structure) AND semantics implied key (string) Key of the query parameter. value (structure) Value of the query parameter. match (oneof) Oneof match field exact-match (string) Exact match condition. exact-not-match (string) Exact not match condition. prefix-match (string) Prefix match condition. prefix-not-match (string) Prefix not match condition. pire-regex-match (string) PIRE regex match condition. pire-regex-not-match (string) PIRE regex not match condition. description (string) Optional description of the rule. 0-512 characters long. name (string) Name of the rule. The name is unique within the captcha. 1-50 characters long. override-variant-uuid (string) Variant UUID to show in case of match the rule. Keep empty to use defaults. priority (integer) Priority of the rule. Lower value means higher priority. Shorthand Syntax [ { condition = { headers = [ { name = string, value = { match = exact-match=string \| exact-not-match=string \| pire-regex-match=string \| pire-regex-not-match=string \| prefix-match=string \| prefix-not-match=string } }, ... ], host = { host-matcher = { match = exact-match=string \| exact-not-match=string \| pire-regex-match=string \| pire-regex-not-match=string \| prefix-match=string \| prefix-not-match=string }, hosts = [ { match = exact-match=string \| exact-not-match=string \| pire-regex-match=string \| pire-regex-not-match=string \| prefix-match=string \| prefix-not-match=string }, ... ] }, source-ip = { geo-ip-match = { locations = string,... }, geo-ip-not-match = { locations = string,... }, ip-ranges-match = { ip-ranges = string,... }, ip-ranges-not-match = { ip-ranges = string,... } }, uri = { path = { match = exact-match=string \| exact-not-match=string \| pire-regex-match=string \| pire-regex-not-match=string \| prefix-match=string \| prefix-not-match=string }, queries = [ { key = string, value = { match = exact-match=string \| exact-not-match=string \| pire-regex-match=string \| pire-regex-not-match=string \| prefix-match=string \| prefix-not-match=string } }, ... ] } }, description = string, name = string, override-variant-uuid = string, priority = integer }, ... ] JSON Syntax [ { "condition": { "headers": [ { "name": "string", "value": { "match": { "exact-match": "string", "exact-not-match": "string", "pire-regex-match": "string", "pire-regex-not-match": "string", "prefix-match": "string", "prefix-not-match": "string" } } }, ... ], "host": { "host-matcher": { "match": { "exact-match": "string", "exact-not-match": "string", "pire-regex-match": "string", "pire-regex-not-match": "string", "prefix-match": "string", "prefix-not-match": "string" } }, "hosts": [ { "match": { "exact-match": "string", "exact-not-match": "string", "pire-regex-match": "string", "pire-regex-not-match": "string", "prefix-match": "string", "prefix-not-match": "string" } }, ... ] }, "source-ip": { "geo-ip-match": { "locations": [ "string", ... ] }, "geo-ip-not-match": { "locations": [ "string", ... ] }, "ip-ranges-match": { "ip-ranges": [ "string", ... ] }, "ip-ranges-not-match": { "ip-ranges": [ "string", ... ] } }, "uri": { "path": { "match": { "exact-match": "string", "exact-not-match": "string", "pire-regex-match": "string", "pire-regex-not-match": "string", "prefix-match": "string", "prefix-not-match": "string" } }, "queries": [ { "key": "string", "value": { "match": { "exact-match": "string", "exact-not-match": "string", "pire-regex-match": "string", "pire-regex-not-match": "string", "prefix-match": "string", "prefix-not-match": "string" } } }, ... ] } }, "description": "string", "name": "string", "override-variant-uuid": "string", "priority": "integer" }, ... ]
`--style-json`	`string` JSON with variables to define the captcha appearance. For more details see generated JSON in cloud console.
`--turn-off-hostname-check`	Turn off host name check, see documentation.
`--async`	Display information about the operation in progress, without waiting for the operation to complete.

Global Flags

Flag	Description
`--profile`	`string` Set the custom profile.
`--region`	`string` Set the region.
`--debug`	Debug logging.
`--debug-grpc`	Debug gRPC logging. Very verbose, used for debugging connection problems.
`--no-user-output`	Disable printing user intended output to stderr.
`--pager`	`string` Set the custom pager.
`--format`	`string` Set the output format: text, yaml, json, table, summary \|\| summary[name, instance.id, instance.disks[0].size].
`--retry`	`int` Enable gRPC retries. By default, retries are enabled with maximum 5 attempts. Pass 0 to disable retries. Pass any negative value for infinite retries. Even infinite retries are capped with 2 minutes timeout.
`--timeout`	`string` Set the timeout.
`--token`	`string` Set the IAM token to use.
`--impersonate-service-account-id`	`string` Set the ID of the service account to impersonate.
`--no-browser`	Disable opening browser for authentication.
`--query`	`string` Query to select values from the response using jq syntax
`--syntax`	`string` CLI syntax: this standalone binary only supports 2 (current). Use main yc for syntax 1.
`-h`, `--help`	Display help for the command.

Создать капчу

Была ли статья полезна?

Предыдущая

Следующая