Whistle · JSON Structure

Whistle Rule Structure

Documents the structure of Whistle proxy rule configuration.

Type: Properties: 3
Debugging ProxyProxyNetwork DebuggingHTTPHTTPSWebSocketDeveloper Tools

Whistle Rule Structure is a JSON Structure definition published by Whistle, describing 3 properties.

Properties

pattern operation value

Meta-schema:

JSON Structure

whistle-rule-structure.json Raw ↑
{
  "title": "Whistle Rule Structure",
  "description": "Documents the structure of Whistle proxy rule configuration.",
  "version": "1.0.0",
  "properties": {
    "pattern": {
      "type": "string",
      "description": "URL pattern for matching requests",
      "notes": "Supports exact match, wildcard (*), and regex (^/path/)"
    },
    "operation": {
      "type": "string",
      "description": "The transformation operation to apply",
      "enum": [
        "file - Map to local file",
        "xfile - Map to file without changing Content-Type",
        "tpl - Map to template file",
        "http - Forward to HTTP URL",
        "https - Forward to HTTPS URL",
        "host - Override DNS resolution",
        "proxy - Forward through proxy",
        "statusCode - Return specific HTTP status code",
        "reqHeaders - Set request headers",
        "resHeaders - Set response headers",
        "resCors - Set CORS response headers",
        "log - Log request/response to console",
        "weinre - Attach Weinre debugger",
        "delay - Add delay to request",
        "speed - Throttle response speed"
      ]
    },
    "value": {
      "type": "string",
      "description": "The target value for the operation"
    }
  },
  "examples": [
    {
      "description": "Map API to local mock file",
      "rule": "api.example.com/users file:///path/to/users.json"
    },
    {
      "description": "Forward to test server",
      "rule": "www.example.com/api http://test.example.com/api"
    },
    {
      "description": "Set CORS headers",
      "rule": "api.example.com resCors://*"
    }
  ]
}

Work with this as data

Every JSON Structure 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 json structure

4 MCP tools reach this
  • find_json_structuresBrowse and filter every JSON Structure in the catalog.
  • 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 JSON Structure
curl "https://apis.io/api/v1/json-structures/whistle-rule-structure"
All json structure
curl "https://apis.io/api/v1/json-structures?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

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