Skip to main content
PATCH
https://{tenantDomain}/api/v2
/
attack-protection
/
captcha
Partial Update for CAPTCHA Configuration
curl --request PATCH \
  --url https://{tenantDomain}/api/v2/attack-protection/captcha \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "simple_captcha": {}
}
'
{
  "active_provider_id": "<string>",
  "arkose": {
    "site_key": "<string>",
    "fail_open": true,
    "client_subdomain": "<string>",
    "verify_subdomain": "<string>"
  },
  "auth_challenge": {
    "fail_open": true
  },
  "hcaptcha": {
    "site_key": "<string>"
  },
  "friendly_captcha": {
    "site_key": "<string>"
  },
  "recaptcha_enterprise": {
    "site_key": "<string>",
    "project_id": "<string>"
  },
  "recaptcha_v2": {
    "site_key": "<string>"
  },
  "simple_captcha": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

​
active_provider_id
enum<string>

The id of the active provider for the CAPTCHA.

Available options:
arkose,
auth_challenge,
friendly_captcha,
hcaptcha,
recaptcha_v2,
recaptcha_enterprise,
simple_captcha
Maximum string length: 36
​
arkose
object
​
auth_challenge
object
​
hcaptcha
object
​
friendly_captcha
object
​
recaptcha_enterprise
object
​
recaptcha_v2
object
​
simple_captcha
object

Response

Captcha configuration successfully retrieved.

​
active_provider_id
string
​
arkose
object
​
auth_challenge
object
​
hcaptcha
object
​
friendly_captcha
object
​
recaptcha_enterprise
object
​
recaptcha_v2
object
​
simple_captcha
object