projects

POST /v1/projects/{projectsId}/keys/{keysId}:migrate

Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. Once a key is migrated, it can be used from either product. SiteVerify requests are billed as CreateAssessment calls. You must be authenticated as one of the current owners of the reCAPTCHA Key, and your user must have the reCAPTCHA Enterprise Admin IAM role in the destination project.

Request

  • Base URL
    https://recaptchaenterprise.googleapis.com
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/cloud-platform
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/cloud-platform

Path parameters

projectsIdstring required
keysIdstring required

Request body

skipBillingCheckboolean

Optional. If true, skips the billing check. A reCAPTCHA Enterprise key or migrated key behaves differently than a reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see https://docs.cloud.google.com/recaptcha/quotas#quota_limit). To avoid any disruption of your usage, we check that a billing account is present. If your usage of reCAPTCHA is under the free quota, you can safely skip the billing check and proceed with the migration. See https://cloud.google.com/recaptcha/docs/billing-information.

Response

Successful response

createTimestring google-datetime

Output only. The timestamp corresponding to the creation of this key.

displayNamestring

Required. Human-readable display name of this key. Modifiable by user.

expressSettingsGoogleCloudRecaptchaenterpriseV1ExpressKeySettings

Settings specific to keys that can be used for reCAPTCHA Express.

labelsobject

Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels).

namestring

Identifier. The resource name for the Key in the format projects/{project}/keys/{key}.

universalSettingsGoogleCloudRecaptchaenterpriseV1UniversalKeySettings

Settings for keys that are configured through their Policy.

Changes

No recorded changes to this operation across all 4 revisions of this API.