--- title: Turnstile --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) 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/go/resources/turnstile/subresources/widgets/methods/list) client.Turnstile.Widgets.List(ctx, params) (\*V4PagePaginationArray\[[WidgetListResponse]()], error) GET/accounts/{account\_id}/challenges/widgets ##### [Turnstile Widget Details](https://developers.cloudflare.com/api/go/resources/turnstile/subresources/widgets/methods/get) client.Turnstile.Widgets.Get(ctx, sitekey, query) (\*[Widget](), error) GET/accounts/{account\_id}/challenges/widgets/{sitekey} ##### [Create a Turnstile Widget](https://developers.cloudflare.com/api/go/resources/turnstile/subresources/widgets/methods/create) client.Turnstile.Widgets.New(ctx, params) (\*[Widget](), error) POST/accounts/{account\_id}/challenges/widgets ##### [Update a Turnstile Widget](https://developers.cloudflare.com/api/go/resources/turnstile/subresources/widgets/methods/update) client.Turnstile.Widgets.Update(ctx, sitekey, params) (\*[Widget](), error) PUT/accounts/{account\_id}/challenges/widgets/{sitekey} ##### [Delete a Turnstile Widget](https://developers.cloudflare.com/api/go/resources/turnstile/subresources/widgets/methods/delete) client.Turnstile.Widgets.Delete(ctx, sitekey, body) (\*[Widget](), error) DELETE/accounts/{account\_id}/challenges/widgets/{sitekey} ##### [Rotate Secret for a Turnstile Widget](https://developers.cloudflare.com/api/go/resources/turnstile/subresources/widgets/methods/rotate_secret) client.Turnstile.Widgets.RotateSecret(ctx, sitekey, params) (\*[Widget](), error) POST/accounts/{account\_id}/challenges/widgets/{sitekey}/rotate\_secret ##### ModelsExpand Collapse

type Widget struct{…} A Turnstile widget’s detailed configuration

BotFightMode 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

ClearanceLevel WidgetClearanceLevel 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: const WidgetClearanceLevelNoClearance WidgetClearanceLevel = "no\_clearance" Link to this property const WidgetClearanceLevelJschallenge WidgetClearanceLevel = "jschallenge" Link to this property const WidgetClearanceLevelManaged WidgetClearanceLevel = "managed" Link to this property const WidgetClearanceLevelInteractive WidgetClearanceLevel = "interactive" Link to this property

Link to this property CreatedOn Time When the widget was created. formatdate-time Link to this property Domains \[]WidgetDomain maxLength10 Link to this property EphemeralID bool Return the Ephemeral ID in /siteverify (ENT only). Link to this property

Mode WidgetMode Widget Mode

One of the following: const WidgetModeNonInteractive WidgetMode = "non-interactive" Link to this property const WidgetModeInvisible WidgetMode = "invisible" Link to this property const WidgetModeManaged WidgetMode = "managed" Link to this property

Link to this property ModifiedOn Time When the widget was modified. formatdate-time Link to this property Name string 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 WidgetRegion Region where this widget can be used. This cannot be changed after creation.

One of the following: const WidgetRegionWorld WidgetRegion = "world" Link to this property const WidgetRegionChina WidgetRegion = "china" Link to this property

Link to this property Secret string Secret key for this widget. Link to this property Sitekey string Unique identifier for a Turnstile widget. maxLength32 Link to this property

DeployedVia WidgetDeployedViaOptional 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: const WidgetDeployedViaWrangler WidgetDeployedVia = "wrangler" Link to this property const WidgetDeployedViaDashboard WidgetDeployedVia = "dashboard" Link to this property const WidgetDeployedViaSpin WidgetDeployedVia = "spin" Link to this property const WidgetDeployedViaAPI WidgetDeployedVia = "api" Link to this property const WidgetDeployedViaUnknown WidgetDeployedVia = "unknown" Link to this property

Link to this property

LastModifiedVia WidgetLastModifiedViaOptional 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: const WidgetLastModifiedViaWrangler WidgetLastModifiedVia = "wrangler" Link to this property const WidgetLastModifiedViaDashboard WidgetLastModifiedVia = "dashboard" Link to this property const WidgetLastModifiedViaSpin WidgetLastModifiedVia = "spin" Link to this property const WidgetLastModifiedViaAPI WidgetLastModifiedVia = "api" Link to this property const WidgetLastModifiedViaUnknown WidgetLastModifiedVia = "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)>) type WidgetDomain string 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)>)