# Replace the environment's bot and abuse protection settings

<div class="api-op" data-api-operation>
<div class="api-op__main">

<p class="api-endpoint"><span class="method method-put">PUT</span> <code>/v1/user_management/bot_protection</code></p>

Rules run in list order and the first match decides (`allow` stops evaluation). The rules engine needs a Business plan, the developer's own Turnstile keys and new-device emails a Pro plan (`plan_limit_reached` otherwise); the managed CAPTCHA, device signals and the detections log are on every plan. `captcha_provider: managed` needs OhAuthCat's widget to be configured for the deployment (`parameter_invalid` otherwise). Changes apply to the hosted pages within seconds.

<dl class="api-facts"><div><dt>Scope</dt><dd><code>users:write</code></dd></div><div><dt>Auth</dt><dd>Secret key (<code>sk_…</code>)</dd></div><div><dt>Since</dt><dd>1.0</dd></div></dl>

## Headers

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">OhAuthCat-Version</code> <span class="api-field__type">string</span></p>
Minor version; defaults to the environment's pin.
</li>
</ul>

## Request body

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">captcha_mode</code> <span class="api-field__type">string</span> <span class="api-field__required">Required</span></p>

<p class="api-field__chips">one of <code>off</code>, <code>adaptive</code>, <code>always</code></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">captcha_provider</code> <span class="api-field__type">string</span> <span class="api-field__required">Required</span></p>

<p class="api-field__chips">one of <code>managed</code>, <code>own</code></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">turnstile_site_key</code> <span class="api-field__type">string or null</span></p>

<p class="api-field__chips">max length 128</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">turnstile_secret</code> <span class="api-field__type">string</span></p>
The developer's Turnstile secret, sealed at rest and never returned. Omit to keep the stored one.

<p class="api-field__chips">min length 1 · max length 256</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">clear_turnstile_secret</code> <span class="api-field__type">boolean</span></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">device_tracking</code> <span class="api-field__type">boolean</span> <span class="api-field__required">Required</span></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">new_device_email</code> <span class="api-field__type">boolean</span> <span class="api-field__required">Required</span></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">rules</code> <span class="api-field__type">array of BotRule</span> <span class="api-field__required">Required</span></p>

<p class="api-field__chips">max items 50</p>
</li>
</ul>

## Responses

<ul class="api-responses">
<li class="api-response"><span class="api-status api-status--ok">200</span> <span>OK <span class="api-field__type">BotProtectionSettings</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">400</span> <span>Invalid request. Codes: <a href="/errors/parameter_invalid/">parameter_invalid</a>, <a href="/errors/parameter_missing/">parameter_missing</a>, <a href="/errors/version_unsupported/">version_unsupported</a> and resource-specific codes from the catalogue. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">401</span> <span>Codes: <a href="/errors/authentication_required/">authentication_required</a>, <a href="/errors/api_key_invalid/">api_key_invalid</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">403</span> <span>Codes: <a href="/errors/api_key_scope_missing/">api_key_scope_missing</a>, <a href="/errors/ip_not_allowed/">ip_not_allowed</a>, <a href="/errors/plan_limit_reached/">plan_limit_reached</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">429</span> <span>Code: <a href="/errors/rate_limited/">rate_limited</a>. Retry-After is set. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">503</span> <span>Code: <a href="/errors/service_unavailable/">service_unavailable</a>. Retry-After is set; writes are paused. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--neutral">default</span> <span>Any other error, including <a href="/errors/internal_error/">internal_error</a>. Every code is in the error catalogue. <span class="api-field__type">Error</span></span></li>
</ul>

Errors share one shape; see the [error code catalogue](/errors/).

</div>
<div class="api-op__code">

**curl**

```sh wrap
curl -X PUT \
  "https://api.ohauthcat.com/v1/user_management/bot_protection" \
  -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "captcha_mode": "off",
  "captcha_provider": "managed",
  "device_tracking": true,
  "new_device_email": true,
  "rules": [
    {
      "id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
      "kind": "country",
      "action": "allow",
      "challenge": "captcha",
      "enabled": true,
      "flows": [
        "sign_in"
      ],
      "values": [
        "enterprise"
      ],
      "not_in": true,
      "threshold": 1,
      "window_seconds": 60,
      "days": 1
    }
  ]
}'
```

**Node**

```javascript wrap
const response = await fetch(
  "https://api.ohauthcat.com/v1/user_management/bot_protection",
  {
    method: "PUT",
    headers: {
      Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      captcha_mode: "off",
      captcha_provider: "managed",
      device_tracking: true,
      new_device_email: true,
      rules: [
        {
          id: "01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
          kind: "country",
          action: "allow",
          challenge: "captcha",
          enabled: true,
          flows: ["sign_in"],
          values: ["enterprise"],
          not_in: true,
          threshold: 1,
          window_seconds: 60,
          days: 1,
        },
      ],
    }),
  },
);
const data = await response.json();
```

**Python**

```python wrap
import os
import requests

response = requests.put(
    "https://api.ohauthcat.com/v1/user_management/bot_protection",
    headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},
    json={
        "captcha_mode": "off",
        "captcha_provider": "managed",
        "device_tracking": True,
        "new_device_email": True,
        "rules": [
            {
                "id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
                "kind": "country",
                "action": "allow",
                "challenge": "captcha",
                "enabled": True,
                "flows": [
                    "sign_in",
                ],
                "values": [
                    "enterprise",
                ],
                "not_in": True,
                "threshold": 1,
                "window_seconds": 60,
                "days": 1,
            },
        ],
    },
)
data = response.json()
```

```json title="Response 200" wrap
{
  "object": "bot_protection",
  "captcha_mode": "off",
  "captcha_provider": "managed",
  "turnstile_site_key": "plan",
  "turnstile_secret_set": true,
  "device_tracking": true,
  "new_device_email": true,
  "rules": [
    {
      "id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
      "kind": "country",
      "action": "allow",
      "challenge": "captcha",
      "enabled": true,
      "flows": ["sign_in"],
      "values": ["enterprise"],
      "not_in": true,
      "threshold": 1,
      "window_seconds": 60,
      "days": 1
    }
  ]
}
```

</div>
</div>
