Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Turnstile API

The Turnstile API from APIs.io Engineering Platform — 3 operation(s) for turnstile.

This API exposes 6 operations across 3 paths, and defines 19 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

6 operations 3 paths 19 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Turnstile API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Turnstile 6
GET
/accounts/{account_id}/challenges/widgets
APIs.io Engineering Platform List Turnstile Widgets
accounts-turnstile-widgets-list 5 params → 4XX200
POST
/accounts/{account_id}/challenges/widgets
APIs.io Engineering Platform Create a Turnstile Widget
accounts-turnstile-widget-create 5 params body → 4XX200
DELETE
/accounts/{account_id}/challenges/widgets/{sitekey}
APIs.io Engineering Platform Delete a Turnstile Widget
accounts-turnstile-widget-delete 2 params → 4XX200
GET
/accounts/{account_id}/challenges/widgets/{sitekey}
APIs.io Engineering Platform Turnstile Widget Details
accounts-turnstile-widget-get 2 params → 4XX200
PUT
/accounts/{account_id}/challenges/widgets/{sitekey}
APIs.io Engineering Platform Update a Turnstile Widget
accounts-turnstile-widget-update 2 params body → 4XX200
POST
/accounts/{account_id}/challenges/widgets/{sitekey}/rotate_secret
APIs.io Engineering Platform Rotate Secret for a Turnstile Widget
accounts-turnstile-widget-rotate-secret 2 params body → 4XX200

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are turnstile_widget_detail (11 properties), turnstile_widget_list (10 properties), turnstile_api-response-common-failure (4 properties), turnstile_result_info (4 properties). Each schema is shown below with its type and property counts.

turnstile_api-response-common-failure
object
4 properties 4 required
turnstile_secret
string
Secret key for this widget.
turnstile_domains
array
turnstile_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…
turnstile_sitekey
string
Widget item identifier tag.
turnstile_api-response-common
object
3 properties 3 required
turnstile_messages
array
turnstile_invalidate_immediately
boolean
If invalidateimmediately is set to false, the previous secret will remain valid for two hours. Otherwise, the secret is immediately invalidated, and requests u…
turnstile_offlabel
boolean
Do not show any Cloudflare branding on the widget (ENT only).
turnstile_region
string
Region where this widget can be used.
turnstile_mode
string
Widget Mode
turnstile_result_info
object
4 properties 4 required
turnstile_clearance_level
string
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
turnstile_bot_fight_mode
boolean
If botfightmode is set to true, Cloudflare issues computationally expensive challenges in response to malicious bots (ENT only).
turnstile_widget_list
object
A Turnstile Widgets configuration as it appears in listings
10 properties 10 required
turnstile_widget_detail
object
A Turnstile widget's detailed configuration
11 properties 11 required
turnstile_identifier
string
Identifier
turnstile_created_on
string
When the widget was created.
turnstile_modified_on
string
When the widget was modified.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-turnstile-api-openapi.yml Raw ↑