Skip to content

Update bot protection

PATCH
/teams/{teamId}/domains/{domainId}/bot-protection
curl --request PATCH \
--url https://qinto-api.blotout.io/teams/7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9/domains/3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15/bot-protection \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "minBotScore": 30, "countries": { "mode": "block", "list": [ "CN", "RU" ] }, "blockVerifiedBots": false }'

Changes any of the site’s minimum bot score, country allow/block rule and verified-bot blocking in one call, which the site applies with a single redeploy. Send countries: null to clear country filtering.

How it works

Settings left out keep their value, and a value the site already has changes nothing. When blockVerifiedBots is false, verified bots skip the minimum bot score, but country rules still apply. deployed is false until the site serves every stored setting: deploy a site that has never deployed; a deployed one retries on its own.

Required permissions

  • domain:write on all domains, or on the addressed domain when its id is in the route
teamId
required

Unique id (UUID) of the team that owns the addressed resources, as shown in the team settings on the Blotout platform.

string format: uuid

Example

7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9

Unique id (UUID) of the team that owns the addressed resources, as shown in the team settings on the Blotout platform.

domainId
required

Unique id (UUID) of the site, as returned by the create and list operations.

string format: uuid

Example

3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15

Unique id (UUID) of the site, as returned by the create and list operations.

The bot protection settings to change.

Media typeapplication/json

Any of minBotScore, countries and blockVerifiedBots. Settings left out keep their current value.

object
minBotScore

Replacement minimum Cloudflare bot score, from 1 through 99.

integer
>= 1 <= 99

Example

30
countries

Replacement country allow/block rule, or null to clear country filtering.

object
mode
required

allow admits only the listed countries; block admits every country except those listed.

string
Allowed values: allow block

Example

block
list
required

ISO 3166-1 alpha-2 country codes, plus EU for the Union as a whole. At least one.

Array<string>
>= 1 items

Example

[
"CN",
"RU"
]

Example

{
"mode": "block",
"list": [
"CN",
"RU"
]
}
blockVerifiedBots

true blocks verified bots; false lets them skip the minimum bot score.

boolean

Example

false

The settings now stored, and whether the site already serves them.

Media typeapplication/json
object
minBotScore
required

The minimum bot score now stored for the site.

integer
countries
required

The country rule now stored for the site, or null when country filtering is off.

object
mode
required

allow admits only the listed countries; block admits every country except those listed.

string
Allowed values: allow block
list
required

ISO 3166-1 alpha-2 country codes, plus EU for the Union as a whole.

Array<string>
blockVerifiedBots
required

Whether the site now blocks verified bots.

boolean
deployed
required

Whether the site already serves every setting stored for it. False on a site that has never deployed — call deploy — and false while a change has not reached the site yet, which retries on its own.

boolean

Example

{
"minBotScore": 30,
"countries": null,
"blockVerifiedBots": true,
"deployed": true
}

invalid_params — A path parameter failed validation (for example a malformed UUID); details pinpoints the offending parameter. invalid_body — The JSON body is unparseable or failed schema validation; details pinpoints the offending fields when the body could be parsed. invalid_bot_protection — The bot score or country rule was rejected. message states which.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: invalid_params invalid_body invalid_bot_protection
message

Human-readable reason for this specific failure, intended for display — do not parse it programmatically.

string
details

Field-level validation errors: a tree keyed by input property, each node carrying an errors array of human-readable messages. Render it to help the caller correct the request.

object
key
additional properties

Example

{
"error": "invalid_params",
"message": "The Cloudflare API token is invalid or expired.",
"details": {
"errors": [],
"properties": {
"teamId": {
"errors": [
"Invalid UUID"
]
}
}
}
}

unauthenticated — The Authorization: Bearer token is missing, malformed, or no longer valid. Generate a team API token or obtain a new OAuth access token.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: unauthenticated

Example

{
"error": "unauthenticated"
}

forbidden — The bearer credential lacks the required permission or belongs to another team, or its user lacks the organization role a developer operation needs. Update its policies, use a credential bound to the addressed team, or ask an organization owner for the role; message states the reason when one is known.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: forbidden
message

Human-readable reason for this specific failure, intended for display — do not parse it programmatically.

string

Example

{
"error": "forbidden",
"message": "The Cloudflare API token is invalid or expired."
}

not_found — The addressed resource does not exist within this team; check the id and retry.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: not_found

Example

{
"error": "not_found"
}

internal — Unexpected server error. Nothing is guaranteed to have been persisted; idempotent operations are safe to retry.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: internal

Example

{
"error": "internal"
}