This documentation is currently under development. Certain sections are not yet complete and will be added shortly.
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Turnstile

Get the Cloudflare Turnstile site key

get
/api/{tenantId}/admin/extensions/cloudflare/turnstile

Returns the public Turnstile site key configured for this tenant. Returns 404 when Turnstile is not configured. The secret key is not returned for security reasons.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2implicitRequired
Authorization URL:
Path parameters
tenantIdstringRequired
Responses
200

Configuration returned.

Response body for Turnstile configuration.

siteKeystring · min: 1Required

Public site key configured for this tenant.

proofCookieValidityDurationSecondsinteger · int32Optional

Duration in seconds the proof cookie remains valid. 0 means disabled.

get/api/{tenantId}/admin/extensions/cloudflare/turnstile

Set Cloudflare Turnstile configuration

put
/api/{tenantId}/admin/extensions/cloudflare/turnstile

Saves the Turnstile site key to server/cloudflare.yml. Omit secretKey to update the site key without rotating the secret.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2implicitRequired
Authorization URL:
Path parameters
tenantIdstringRequired
Body

Request body for setting Turnstile configuration.

siteKeystring · min: 1Required

Public site key used by the web client to render the Turnstile widget.

secretKeystring · nullableOptional

Secret key used by the server to verify Turnstile tokens. Stored in the secret repository under CLOUDFLARE-TURNSTILE-SECRETKEY. When omitted, the existing secret is preserved.

proofCookieValidityDurationSecondsinteger · int32Required

Duration in seconds the proof cookie remains valid after a successful challenge. Set to 0 to disable the proof cookie bypass.

Responses
204

Configuration saved.

No content

put/api/{tenantId}/admin/extensions/cloudflare/turnstile

No content

Delete Cloudflare Turnstile configuration

delete
/api/{tenantId}/admin/extensions/cloudflare/turnstile

Removes server/cloudflare.yml from tenant configuration. This disables Turnstile for the tenant. Also removes the Turnstile secret when present.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2implicitRequired
Authorization URL:
Path parameters
tenantIdstringRequired
Responses
204

Configuration deleted.

No content

delete/api/{tenantId}/admin/extensions/cloudflare/turnstile

No content

Last updated