Get captcha settings for the environment

GET

environments

{environmentId}

settings

captcha

Get captcha settings for the environment

curl --request GET \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/settings/captcha \
  --header 'Authorization: Bearer <token>'

{
  "enabled": true,
  "siteKey": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

environmentId

string

required

ID of the environment

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Response

Returns the captcha settings for environment

Captcha configuration for an environment. The secret key is never returned.

enabled

boolean

Whether captcha verification is enabled

provider

enum<string>

Captcha provider used for verification

Available options:

hcaptcha,

cloudflareTurnstile

siteKey

string

Public site key used to render the captcha widget

Update captcha settings for the environmentUpdates the captcha settings for the specified environment, including enabling or disabling verification via the `enabled` field. The secret key is encrypted at rest and never returned.

⌘I

Get captcha settings for the environment

curl --request GET \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/settings/captcha \
  --header 'Authorization: Bearer <token>'

{
  "enabled": true,
  "siteKey": "<string>"
}