Create a Turnstile Widget

client.turnstile.widgets.create(, ?): Widget { bot_fight_mode, clearance_level, created_on, 9 more }

POST/accounts/{account_id}/challenges/widgets

Lists challenge widgets.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Turnstile Sites WriteAccount Settings Write

ParametersExpand Collapse

params: WidgetCreateParams { account_id, domains, mode, 11 more }

account_id: string

Path param: Identifier

maxLength32

domains: Array<WidgetDomain>

Body param

maxLength10

mode: "non-interactive" | "invisible" | "managed"

Body param: Widget Mode

One of the following:

"non-interactive"

"invisible"

"managed"

name: string

Body param: 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

direction?: "asc" | "desc"

Query param: Direction to order widgets.

One of the following:

"asc"

"desc"

filter?: string

Query param: Filter widgets by field using case-insensitive substring matching. Format: field:value

Supported fields:

name - Filter by widget name (e.g., filter=name:login-form)
sitekey - Filter by sitekey (e.g., filter=sitekey:0x4AAA)

Returns 400 Bad Request if the field is unsupported or format is invalid. An empty filter value returns all results.

order?: "id" | "sitekey" | "name" | 2 more

Query param: Field to order widgets by.

One of the following:

"id"

"sitekey"

"name"

"created_on"

"modified_on"

page?: number

Query param: Page number of paginated results.

minimum1

per_page?: number

Query param: Number of items per page.

maximum1000

minimum5

bot_fight_mode?: boolean

Body param: If bot_fight_mode is set to true, Cloudflare issues computationally expensive challenges in response to malicious bots (ENT only).

clearance_level?: "no_clearance" | "jschallenge" | "managed" | "interactive"

Body param: 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"

"jschallenge"

"managed"

"interactive"

ephemeral_id?: boolean

Body param: Return the Ephemeral ID in /siteverify (ENT only).

offlabel?: boolean

Body param: Do not show any Cloudflare branding on the widget (ENT only).

region?: "world" | "china"

Body param: Region where this widget can be used. This cannot be changed after creation.

One of the following:

"world"

"china"

ReturnsExpand Collapse

One of the following:

Create a Turnstile Widget

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const widget = await client.turnstile.widgets.create({
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
  domains: ['203.0.113.1', 'cloudflare.com', 'blog.example.com'],
  mode: 'invisible',
  name: 'blog.cloudflare.com login form',
});

console.log(widget.ephemeral_id);

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "bot_fight_mode": false,
    "clearance_level": "interactive",
    "created_on": "2014-01-01T05:20:00.123123Z",
    "domains": [
      "203.0.113.1",
      "cloudflare.com",
      "blog.example.com"
    ],
    "ephemeral_id": false,
    "mode": "invisible",
    "modified_on": "2014-01-01T05:20:00.123123Z",
    "name": "blog.cloudflare.com login form",
    "offlabel": false,
    "region": "world",
    "secret": "0x4AAF00AAAABn0R22HWm098HVBjhdsYUc",
    "sitekey": "0x4AAF00AAAABn0R22HWm-YUc"
  },
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "bot_fight_mode": false,
    "clearance_level": "interactive",
    "created_on": "2014-01-01T05:20:00.123123Z",
    "domains": [
      "203.0.113.1",
      "cloudflare.com",
      "blog.example.com"
    ],
    "ephemeral_id": false,
    "mode": "invisible",
    "modified_on": "2014-01-01T05:20:00.123123Z",
    "name": "blog.cloudflare.com login form",
    "offlabel": false,
    "region": "world",
    "secret": "0x4AAF00AAAABn0R22HWm098HVBjhdsYUc",
    "sitekey": "0x4AAF00AAAABn0R22HWm-YUc"
  },
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}