Edge Network

Edge Network Shield API

Free privacy-first CAPTCHA alternative with verified-agent policies.

GitHub OpenAPI

Operations 5

GET /agent/shield/widgets List Shield widgets #
POST /agent/shield/widgets Create a Shield widget #
PATCH /agent/shield/widgets/{id} Update a Shield widget #
DELETE /agent/shield/widgets/{id} Revoke a Shield widget #
GET /agent/shield/widgets/{id}/stats Shield widget traffic stats #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/edge-network/openapi/edge-network-shield-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/edge-network/json-schema/edge-network-shield-widget-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/edge-network:edge-network-shield-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

edge-network-shield-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Edge Network Agent Shield API
  version: 1.1.0
  description: 'REST API built for AI agents: provision and manage CDN, compute VMs, S3-compatible object storage, DNS, Shield bot protection, and Assist AI site answers on the Edge Network decentralised cloud. Every response includes a tell_user field with a human-readable summary. Every mutating operation supports X-Dry-Run: true (preview without changes) and Idempotency-Key (safe retries). Agents without credentials can sign themselves up autonomously via /agent/signup (Ed25519 keypair + proof-of-work — no card, no human) and immediately deploy free-tier resources. Also available as an MCP server: https://edge.network/mcp (streamable HTTP) or npx @edge-network/mcp (stdio).


    Versioning: the current major version is 1, signalled by the X-API-Version response header on every response. Additive changes (new endpoints, new optional fields) ship without a version bump and never break existing integrations. Breaking changes ship under a new URL prefix (e.g. /agent/v2/) with at least 6 months of overlap; during the migration window the old surface returns Deprecation and Sunset headers (RFC 8594). Full policy: https://edge.network/docs/api/versioning.


    Rate limits: responses carry IETF RateLimit-Limit / RateLimit-Remaining / RateLimit-Reset headers (plus RateLimit-Policy); 429 responses include Retry-After.'
  contact:
    name: Edge Network support
    email: support@edge.network
    url: https://edge.network/support
  termsOfService: https://edge.network/terms
servers:
- url: https://edge.network
  description: Production
security:
- agentCode: []
tags:
- name: Shield
  description: Free privacy-first CAPTCHA alternative with verified-agent policies.
paths:
  /agent/shield/widgets:
    get:
      operationId: listShieldWidgets
      summary: List Shield widgets
      description: All Edge Shield bot-protection widgets (sitekeys) on the account.
      tags:
      - Shield
      responses:
        '200':
          description: Success.
          headers:
            X-API-Version:
              $ref: '#/components/headers/XApiVersion'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
          content:
            application/json:
              schema:
                type: object
                properties:
                  widgets:
                    type: array
                    items:
                      $ref: '#/components/schemas/ShieldWidget'
                  tell_user:
                    type: string
                    description: Human-readable summary of what happened, for the agent to relay to its operator.
                required:
                - widgets
        '400':
          description: Validation error — the response body explains what to fix.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid agent access code. The body includes self-signup pointers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited. Honour Retry-After and the RateLimit-* headers before retrying.
          headers:
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
            X-API-Version:
              $ref: '#/components/headers/XApiVersion'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - agentCode: []
    post:
      operationId: createShieldWidget
      summary: Create a Shield widget
      description: 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.
      tags:
      - Shield
      responses:
        '201':
          description: Success.
          headers:
            X-API-Version:
              $ref: '#/components/headers/XApiVersion'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
          content:
            application/json:
              schema:
                type: object
                properties:
                  widget:
                    $ref: '#/components/schemas/ShieldWidget'
                  tell_user:
                    type: string
                    description: Human-readable summary of what happened, for the agent to relay to its operator.
                required:
                - widget
        '400':
          description: Validation error — the response body explains what to fix.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid agent access code. The body includes self-signup pointers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited. Honour Retry-After and the RateLimit-* headers before retrying.
          headers:
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
            X-API-Version:
              $ref: '#/components/headers/XApiVersion'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      parameters:
      - name: X-Dry-Run
        in: header
        required: false
        description: Set to "true" to preview the operation (validation, cost, plan) without making changes.
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
      - name: Idempotency-Key
        in: header
        required: false
        description: Unique key for safe retries. Repeating a request with the same key returns the original response instead of re-executing.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Friendly name, e.g. "Contact form".
                hostnames:
                  type: array
                  items:
                    type: string
                  description: Hostnames allowed to use this widget. Empty = any.
                mode:
                  type: string
                  enum:
                  - managed
                  - non-interactive
                  - invisible
                  default: managed
                  description: 'managed: invisible for humans, one-click check when suspicious. non-interactive: never asks for input. invisible: verify via JS API only.'
                agent_policy:
                  type: string
                  enum:
                  - allow
                  - challenge
                  - block
                  default: allow
                  description: Treatment of cryptographically verified AI agents (Web Bot Auth).
              required:
              - name
      security:
      - agentCode: []
  /agent/shield/widgets/{id}:
    patch:
      operationId: updateShieldWidget
      summary: Update a Shield widget
      description: Change name, hostnames, mode, or agent_policy.
      tags:
      - Shield
      responses:
        '200':
          description: Success.
          headers:
            X-API-Version:
              $ref: '#/components/headers/XApiVersion'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
          content:
            application/json:
              schema:
                type: object
                properties:
                  widget:
                    $ref: '#/components/schemas/ShieldWidget'
                  tell_user:
                    type: string
                    description: Human-readable summary of what happened, for the agent to relay to its operator.
                required:
                - widget
        '400':
          description: Validation error — the response body explains what to fix.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid agent access code. The body includes self-signup pointers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited. Honour Retry-After and the RateLimit-* headers before retrying.
          headers:
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
            X-API-Version:
              $ref: '#/components/headers/XApiVersion'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      parameters:
      - name: id
        in: path
        required: true
        description: Widget id.
        schema:
          type: string
      - name: X-Dry-Run
        in: header
        required: false
        description: Set to "true" to preview the operation (validation, cost, plan) without making changes.
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
      - name: Idempotency-Key
        in: header
        required: false
        description: Unique key for safe retries. Repeating a request with the same key returns the original response instead of re-executing.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                hostnames:
                  type: array
                  items:
                    type: string
                mode:
                  type: string
                  enum:
                  - managed
                  - non-interactive
                  - invisible
                agent_policy:
                  type: string
                  enum:
                  - allow
                  - challenge
                  - block
      security:
      - agentCode: []
    delete:
      operationId: deleteShieldWidget
      summary: Revoke a Shield widget
      description: The widget's sitekey and secret stop working immediately.
      tags:
      - Shield
      responses:
        '200':
          description: Success.
          headers:
            X-API-Version:
              $ref: '#/components/headers/XApiVersion'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TellUserEnvelope'
        '400':
          description: Validation error — the response body explains what to fix.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid agent access code. The body includes self-signup pointers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited. Honour Retry-After and the RateLimit-* headers before retrying.
          headers:
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
            X-API-Version:
              $ref: '#/components/headers/XApiVersion'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      parameters:
      - name: id
        in: path
        required: true
        description: Widget id.
        schema:
          type: string
      - name: X-Dry-Run
        in: header
        required: false
        description: Set to "true" to preview the operation (validation, cost, plan) without making changes.
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
      - name: Idempotency-Key
        in: header
        required: false
        description: Unique key for safe retries. Repeating a request with the same key returns the original response instead of re-executing.
        schema:
          type: string
      security:
      - agentCode: []
  /agent/shield/widgets/{id}/stats:
    get:
      operationId: getShieldWidgetStats
      summary: Shield widget traffic stats
      description: 'Hourly stats: challenges issued/solved, humanity scores, verifications, blocked replays, verified agents.'
      tags:
      - Shield
      responses:
        '200':
          description: Success.
          headers:
            X-API-Version:
              $ref: '#/components/headers/XApiVersion'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TellUserEnvelope'
        '400':
          description: Validation error — the response body explains what to fix.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid agent access code. The body includes self-signup pointers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited. Honour Retry-After and the RateLimit-* headers before retrying.
          headers:
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
            X-API-Version:
              $ref: '#/components/headers/XApiVersion'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      parameters:
      - name: id
        in: path
        required: true
        description: Widget id.
        schema:
          type: string
      - name: hours
        in: query
        required: false
        description: Window size in hours (default 24, max 720).
        schema:
          type: integer
          minimum: 1
          maximum: 720
          default: 24
      security:
      - agentCode: []
components:
  headers:
    XApiVersion:
      description: Current API major version. Breaking changes ship under a new URL prefix with Deprecation/Sunset headers on the old surface. See https://edge.network/docs/api/versioning.
      schema:
        type: string
        example: '1'
    RateLimitPolicy:
      description: 'Quota policy: "<limit>;w=<window-seconds>", e.g. "600;w=60".'
      schema:
        type: string
        example: 600;w=60
    RateLimitLimit:
      description: Request quota for the current window (IETF draft-ietf-httpapi-ratelimit-headers).
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests remaining in the current window.
      schema:
        type: integer
    RateLimitReset:
      description: Seconds until the quota resets.
      schema:
        type: integer
    RetryAfter:
      description: Seconds to wait before retrying (sent with 429 responses).
      schema:
        type: integer
  schemas:
    TellUserEnvelope:
      type: object
      description: Standard success envelope. Endpoint-specific fields ride alongside tell_user.
      properties:
        tell_user:
          type: string
          description: Human-readable summary of what happened, for the agent to relay to its operator.
      additionalProperties: true
      required:
      - tell_user
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable error code, e.g. VALIDATION_ERROR.
            message:
              type: string
              description: What went wrong.
            suggestions:
              type: array
              items:
                type: string
              description: Concrete next steps for the agent.
            tell_user:
              type: string
              description: Plain-English summary to relay to the operator.
          required:
          - code
          - message
      required:
      - error
    ShieldWidget:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        sitekey:
          type: string
          description: Public sitekey used in the embed snippet.
        hostnames:
          type: array
          items:
            type: string
        mode:
          type: string
          enum:
          - managed
          - non-interactive
          - invisible
        agent_policy:
          type: string
          enum:
          - allow
          - challenge
          - block
      required:
      - id
      - name
      - sitekey
  securitySchemes:
    agentCode:
      type: http
      scheme: bearer
      bearerFormat: ea_live_...
      description: Agent access code. Get one from the Edge console (Account → Agent Access) or autonomously via GET /agent/signup. Public endpoints (discovery, prompt, signup) need no credentials.
externalDocs:
  description: Agent API documentation
  url: https://edge.network/docs/agent