Turnstile

turnstile

Turnstile

Widgets

turnstile.widgets

Methods

Create A Turnstile Widget -> Envelope<>
post/accounts/{account_id}/challenges/widgets

Lists challenge widgets.

Delete A Turnstile Widget -> Envelope<>
delete/accounts/{account_id}/challenges/widgets/{sitekey}

Destroy a Turnstile Widget.

Turnstile Widget Details -> Envelope<>
get/accounts/{account_id}/challenges/widgets/{sitekey}

Show a single challenge widget configuration.

List Turnstile Widgets -> V4PagePaginationArray<{ bot_fight_mode, clearance_level, created_on, 8 more... }>
get/accounts/{account_id}/challenges/widgets

Lists all turnstile widgets of an account.

Rotate Secret For A Turnstile Widget -> Envelope<>
post/accounts/{account_id}/challenges/widgets/{sitekey}/rotate_secret

Generate a new secret key for this widget. If invalidate_immediately is set to false, the previous secret remains valid for 2 hours.

Note that secrets cannot be rotated again during the grace period.

Update A Turnstile Widget -> Envelope<>
put/accounts/{account_id}/challenges/widgets/{sitekey}

Update the configuration of a widget.

Domain types

Widget = { bot_fight_mode, clearance_level, created_on, 9 more... }

A Turnstile widget's detailed configuration

WidgetDomain = string

Hosts as a hostname or IPv4/IPv6 address represented by strings. The widget will only work on these domains, and their subdomains.