--- title: Turnstile --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Turnstile #### TurnstileWidgets ##### [List Turnstile Widgets](https://developers.cloudflare.com/api/python/resources/turnstile/subresources/widgets/methods/list) turnstile.widgets.list(WidgetListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[WidgetListResponse]()] GET/accounts/{account\_id}/challenges/widgets ##### [Turnstile Widget Details](https://developers.cloudflare.com/api/python/resources/turnstile/subresources/widgets/methods/get) turnstile.widgets.get(strsitekey, WidgetGetParams\*\*kwargs) -> [Widget]() GET/accounts/{account\_id}/challenges/widgets/{sitekey} ##### [Create a Turnstile Widget](https://developers.cloudflare.com/api/python/resources/turnstile/subresources/widgets/methods/create) turnstile.widgets.create(WidgetCreateParams\*\*kwargs) -> [Widget]() POST/accounts/{account\_id}/challenges/widgets ##### [Update a Turnstile Widget](https://developers.cloudflare.com/api/python/resources/turnstile/subresources/widgets/methods/update) turnstile.widgets.update(strsitekey, WidgetUpdateParams\*\*kwargs) -> [Widget]() PUT/accounts/{account\_id}/challenges/widgets/{sitekey} ##### [Delete a Turnstile Widget](https://developers.cloudflare.com/api/python/resources/turnstile/subresources/widgets/methods/delete) turnstile.widgets.delete(strsitekey, WidgetDeleteParams\*\*kwargs) -> [Widget]() DELETE/accounts/{account\_id}/challenges/widgets/{sitekey} ##### [Rotate Secret for a Turnstile Widget](https://developers.cloudflare.com/api/python/resources/turnstile/subresources/widgets/methods/rotate_secret) turnstile.widgets.rotate\_secret(strsitekey, WidgetRotateSecretParams\*\*kwargs) -> [Widget]() POST/accounts/{account\_id}/challenges/widgets/{sitekey}/rotate\_secret ##### ModelsExpand Collapse
class Widget: … A Turnstile widget’s detailed configuration bot\_fight\_mode: bool If bot\_fight\_mode is set to true, Cloudflare issues computationally expensive challenges in response to malicious bots (ENT only). Link to this property
clearance\_level: Literal\["no\_clearance", "jschallenge", "managed", "interactive"] If Turnstile is embedded on a Cloudflare site and the widget should grant challenge clearance, this setting can determine the clearance level to be set One of the following: "no\_clearance" Link to this property "jschallenge" Link to this property "managed" Link to this property "interactive" Link to this property
Link to this property created\_on: datetime When the widget was created. formatdate-time Link to this property domains: List\[WidgetDomain] maxLength10 Link to this property ephemeral\_id: bool Return the Ephemeral ID in /siteverify (ENT only). Link to this property
mode: Literal\["non-interactive", "invisible", "managed"] Widget Mode One of the following: "non-interactive" Link to this property "invisible" Link to this property "managed" Link to this property
Link to this property modified\_on: datetime When the widget was modified. formatdate-time Link to this property name: str Human readable widget name. Not unique. Cloudflare suggests that you set this to a meaningful string to make it easier to identify your widget, and where it is used. maxLength254 minLength1 Link to this property offlabel: bool Do not show any Cloudflare branding on the widget (ENT only). Link to this property
region: Literal\["world", "china"] Region where this widget can be used. This cannot be changed after creation. One of the following: "world" Link to this property "china" Link to this property
Link to this property secret: str Secret key for this widget. Link to this property sitekey: str Unique identifier for a Turnstile widget. maxLength32 Link to this property
deployed\_via: Optional\[Literal\["wrangler", "dashboard", "spin", 2 more]] Origin that created this widget, recorded at creation time and immutable afterward. Server-derived from the create request; not client-settable. Omitted from the response for widgets created before this field existed. One of the following: "wrangler" Link to this property "dashboard" Link to this property "spin" Link to this property "api" Link to this property "unknown" Link to this property
Link to this property
last\_modified\_via: Optional\[Literal\["wrangler", "dashboard", "spin", 2 more]] Origin of the most recent mutation (create, update, delete, or secret rotation). Server-derived; not client-settable. Omitted for widgets last mutated before this field existed. One of the following: "wrangler" Link to this property "dashboard" Link to this property "spin" Link to this property "api" Link to this property "unknown" Link to this property
Link to this property
[Link to this property](<#(resource)%20turnstile.widgets%20%3E%20(model)%20widget%20%3E%20(schema)>) str Hosts as a hostname or IPv4/IPv6 address represented by strings. The widget will only work on these domains, and their subdomains. [Link to this property](<#(resource)%20turnstile.widgets%20%3E%20(model)%20widget_domain%20%3E%20(schema)>)
class WidgetListResponse: … A Turnstile Widgets configuration as it appears in listings bot\_fight\_mode: bool If bot\_fight\_mode is set to true, Cloudflare issues computationally expensive challenges in response to malicious bots (ENT only). Link to this property
clearance\_level: Literal\["no\_clearance", "jschallenge", "managed", "interactive"] If Turnstile is embedded on a Cloudflare site and the widget should grant challenge clearance, this setting can determine the clearance level to be set One of the following: "no\_clearance" Link to this property "jschallenge" Link to this property "managed" Link to this property "interactive" Link to this property
Link to this property created\_on: datetime When the widget was created. formatdate-time Link to this property domains: List\[WidgetDomain] maxLength10 Link to this property ephemeral\_id: bool Return the Ephemeral ID in /siteverify (ENT only). Link to this property
mode: Literal\["non-interactive", "invisible", "managed"] Widget Mode One of the following: "non-interactive" Link to this property "invisible" Link to this property "managed" Link to this property
Link to this property modified\_on: datetime When the widget was modified. formatdate-time Link to this property name: str Human readable widget name. Not unique. Cloudflare suggests that you set this to a meaningful string to make it easier to identify your widget, and where it is used. maxLength254 minLength1 Link to this property offlabel: bool Do not show any Cloudflare branding on the widget (ENT only). Link to this property
region: Literal\["world", "china"] Region where this widget can be used. This cannot be changed after creation. One of the following: "world" Link to this property "china" Link to this property
Link to this property sitekey: str Unique identifier for a Turnstile widget. maxLength32 Link to this property
deployed\_via: Optional\[Literal\["wrangler", "dashboard", "spin", 2 more]] Origin that created this widget, recorded at creation time and immutable afterward. Server-derived from the create request; not client-settable. Omitted from the response for widgets created before this field existed. One of the following: "wrangler" Link to this property "dashboard" Link to this property "spin" Link to this property "api" Link to this property "unknown" Link to this property
Link to this property
last\_modified\_via: Optional\[Literal\["wrangler", "dashboard", "spin", 2 more]] Origin of the most recent mutation (create, update, delete, or secret rotation). Server-derived; not client-settable. Omitted for widgets last mutated before this field existed. One of the following: "wrangler" Link to this property "dashboard" Link to this property "spin" Link to this property "api" Link to this property "unknown" Link to this property
Link to this property
[Link to this property](<#(resource)%20turnstile.widgets%20%3E%20(model)%20widget_list_response%20%3E%20(schema)>)