- NAME
-
- gcloud recaptcha keys update - update a Key
- SYNOPSIS
-
-
gcloud recaptcha keys updateKEY[--display-name=DISPLAY_NAME] [--labels=[KEY=VALUE, …]] [--express|--android(--allow-all-package-names|--package-names=[PACKAGE_NAMES, …]) | [--ios:--allow-all-bundle-ids|--bundle-ids=[BUNDLE_IDS, …]--key-id=KEY_ID--private-key-file=PATH_TO_FILE--team-id=TEAM_ID] | [--web:--allow-amp-traffic--security-preference=SECURITY_PREFERENCE--action-score-thresholds=[ACTION_SCORE_THRESHOLDS, …]--default-score-threshold=DEFAULT_SCORE_THRESHOLD--allow-all-domains|--domains=[DOMAINS, …]]] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
- Update a reCAPTCHA Key.
- EXAMPLES
- To update the information of a reCAPTCHA key, run:
gcloud recaptcha keys update test-key --labels = "foo=bar" --web --domains = test.com.mx - POSITIONAL ARGUMENTS
-
- Key resource - The reCAPTCHA Key to update. This represents a Cloud resource.
(NOTE) Some attributes are not given arguments in this group but can be set in
other ways.
To set the
projectattribute:- provide the argument
keyon the command line with a fully specified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
-
KEY - ID of the key or fully qualified identifier for the key.
To set the
keyattribute:- provide the argument
keyon the command line.
- provide the argument
- provide the argument
- Key resource - The reCAPTCHA Key to update. This represents a Cloud resource.
(NOTE) Some attributes are not given arguments in this group but can be set in
other ways.
- FLAGS
-
-
--display-name=DISPLAY_NAME - A human-readable name for the key. Typically a site or app name.
-
--labels=[KEY=VALUE,…] - List of label KEY=VALUE pairs to add.
- At most one of these can be specified:
- Options for the creation of a site key for Express.
-
--express - Configures the Key for Express assessments.
- Options for the creation of a site key for Android.
-
--android - Configures the Key for Android devices.
This flag argument must be specified if any of the other arguments in this group are specified.
- Exactly one of these must be specified:
-
--allow-all-package-names - If set, package name enforcement will NOT be enabled on this key.
-
--package-names=[PACKAGE_NAMES,…] - Android package names of apps allowed to use the key.
Example of a valid package name: 'com.companyname.appname'
-
- Options for the creation of a site key for iOS.
-
--ios - Configures the Key for iOS devices.
This flag argument must be specified if any of the other arguments in this group are specified.
- At most one of these can be specified:
-
--allow-all-bundle-ids - If set, bundle id enforcement will NOT be enabled on this key.
-
--bundle-ids=[BUNDLE_IDS,…] - iOS bundle ids of apps allowed to use the key.
Example of a valid bundle id: 'com.companyname.productname.appname'
-
- Fields that are required to perform Apple-specific integrity checks (recommended for iOS keys).
-
--key-id=KEY_ID - The Apple developer key ID (10-character string).
This flag argument must be specified if any of the other arguments in this group are specified.
-
--private-key-file=PATH_TO_FILE - File path to a private key (downloaded as a text file with a .p8 file extension)
generated for your Apple Developer account. Ensure that DeviceCheck is enabled
for the private key. Use a full or relative path to a local file containing the
value of private_key_file.
This flag argument must be specified if any of the other arguments in this group are specified.
-
--team-id=TEAM_ID - The Apple team ID (10-character string) owning the provisioning profile used to
build your application.
This flag argument must be specified if any of the other arguments in this group are specified.
- Options for the creation of a site key for web.
-
--web - Configures the Key for websites.
This flag argument must be specified if any of the other arguments in this group are specified.
-
--allow-amp-traffic - Whether this key can be used on AMP (Accelerated Mobile Pages) websites.
-
--security-preference=SECURITY_PREFERENCE - Represents the possible challenge frequency and difficulty configurations for a
web key. usability: show fewer and easier challenges. balance: show balanced (in
amount and difficulty) challenges. security: show more and harder challenges.
SECURITY_PREFERENCEmust be one of:balance,challenge-security-preference-unspecified,security,usability. - Configure if you want to use the POLICY_BASED_CHALLENGE option.
-
--action-score-thresholds=[ACTION_SCORE_THRESHOLDS,…] - The action to score threshold used for POLICY_BASED_CHALLENGE. For example:
--action-score-thresholds=login='{"scoreThreshold":
"0.3"}',signup='{"scoreThreshold": "0.1"}' or
--action-score-thresholds=file_path.(json|yaml).
-
KEY - Sets
KEYvalue. -
VALUE - Sets
VALUEvalue.-
scoreThreshold - Sets
scoreThresholdvalue.
-
Shorthand Example:--action-score-thresholds = string ={ scoreThreshold = float }
JSON Example:--action-score-thresholds = '{"string": {"scoreThreshold": float}}'
File Example:--action-score-thresholds = path_to_file. ( yaml | json )
-
-
--default-score-threshold=DEFAULT_SCORE_THRESHOLD - The global threshold to be used for POLICY_BASED_CHALLENGE if no action specific one exists.
- At most one of these can be specified:
-
--allow-all-domains - If set, domain name enforcement will NOT be enabled on this key.
-
--domains=[DOMAINS,…] - Domains or subdomains of websites allowed to use the key. All subdomains of an
allowed domain are automatically allowed. A valid domain requires a host and
must not include any path, port, query or fragment.
Examples of valid domains: 'example.com' 'subdomain.example.com'
-
-
- GCLOUD WIDE FLAGS
- These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$ gcloud helpfor details. - API REFERENCE
- This command uses the
recaptchaenterprise/v1API. The full documentation for this API can be found at: https://cloud.google.com/recaptcha-enterprise/ - NOTES
- This variant is also available:
gcloud alpha recaptcha keys update
gcloud recaptcha keys update
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-05-27 UTC.

