Shield

Create a Shield widget

Create a bot-protection widget for a form or page. Free, unlimited. Returns the sitekey, the secret (shown ONCE — store server-side), and a ready-to-paste embed snippet.

post/agent/shield/widgets

Request

  • Base URL: https://edge.network
  • URL: https://edge.network/agent/shield/widgets
  • Auth: HTTP bearer

Headers

X-Dry-Run'true' | 'false'

Set to "true" to preview the operation (validation, cost, plan) without making changes.

Idempotency-Keystring

Unique key for safe retries. Repeating a request with the same key returns the original response instead of re-executing.

Request body

namestring required

Friendly name, e.g. "Contact form".

hostnamesstring[]

Hostnames allowed to use this widget. Empty = any.

mode'managed' | 'non-interactive' | 'invisible'

managed: invisible for humans, one-click check when suspicious. non-interactive: never asks for input. invisible: verify via JS API only.

agent_policy'allow' | 'challenge' | 'block'

Treatment of cryptographically verified AI agents (Web Bot Auth).

Response

Success.

tell_userstring

Human-readable summary of what happened, for the agent to relay to its operator.

Changes

No recorded changes to this operation across all 1 revision of this API.