Method: projects.apps.recaptchaConfig.patch

TheRecaptchaConfig REST resource is deprecated; it has been renamed toRecaptchaV3Config. Please useUpdateRecaptchaV3Config instead.

Updates theRecaptchaConfig for the specified app.

While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA v3 tokens for App Check tokens.

For security reasons, thesiteSecret field is never populated in the response.

HTTP request

PATCH https://firebaseappcheck.googleapis.com/v1beta/{recaptchaConfig.name=projects/*/apps/*/recaptchaConfig}

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
recaptchaConfig.name

string

Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format:

projects/{project_number}/apps/{app_id}/recaptchaConfig

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. A comma-separated list of names of fields in theRecaptchaConfig to update. Example:siteSecret.

Request body

The request body contains an instance ofRecaptchaConfig.

Response body

If successful, the response body contains an instance ofRecaptchaConfig.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/firebase

For more information, see theOAuth 2.0 Overview.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-09-25 UTC.