Sonicwallsonicwall.com
SonicWall's API program shows strong foundations in contract design and schema quality, giving partners and their agents a reliable surface to build against. However, the program has two critical gaps that undermine partner self-sufficiency: AI agents and automated tooling cannot discover SonicWall's APIs without a human guide, and when integrations fail, neither partners nor their agents receive machine-readable error responses to recover gracefully.
API DesignA clean, typed, well-governed API contract agents can reason about3 pass2 warn0 fail82A
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Auth declared & discoverablevia spec | 25/25 | Authentication is required across the API (declared globally or on every operation), so an agent knows credentials are needed. Investigated: spec 100%, docs 100%. | Agents can only call an API when they can determine its auth posture — a declared scheme, or an explicit statement that none is required. |
| warn | Schema coverage & depthvia spec | 16.7/25 | Only 88% of the 428 operations document both request and response schemas (target 95%+), so an agent can't reliably call the rest. Investigated: spec 67%, sdk 25%. Fix: Document request body and 2xx response schemas for every non-deprecated operation. | Typed, complete request/response schemas are what make agent function-calling possible. |
| pass | Security & governance hygienevia spec | 15/15 | No credential-shaped strings detected in spec. Investigated: spec 100%, sdk 67%, wellknown 0%. | No leaked secrets, no critical lint violations, no OWASP API Top-10 spec smells, and a published vulnerability-disclosure channel. |
| warn | Machine-readable, versioned contractvia spec | 12.5/25 | The API declares no version and exposes no versioning scheme, so an agent can't pin to a stable contract across releases. Investigated: spec 50%, docs 0%. Fix: Set spec.info.version and adopt a versioning scheme so agents can pin to a stable contract. | A current OpenAPI version with a declared versioning scheme lets agents reason about the contract. |
| pass | Example coveragevia sdk | 10/10 | README is present and includes a runnable quickstart. Investigated: sdk 100%, spec 0%. | Examples carry shape semantics schemas under-specify — for humans and agents alike. |
Developer ExperienceThe context both developers and agents need to integrate fast — onboarding, code samples, complete descriptions and worked examples2 pass1 warn1 fail61C
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Description completenessvia sdk | 15/15 | 5/5 operations carry a description. Investigated: sdk 100%, spec 0%. | Complete descriptions are the context humans and agents need to use endpoints. |
| pass | Changelog publishedvia spec | 13/13 | changelog is documented on the docs site at https://www.sonicwall.com/api/changelog, even though it isn't declared in the API spec. Investigated: spec 100%, docs 100%. | A published changelog lets partners track changes without surprise. |
| warn | Quickstart presentvia docs | 12.5/25 | Quickstart page is reachable at https://www.sonicwall.com/api/quickstart (5 variants scanned) but has no runnable code sample in its HTML or .md variant, so there's nothing to copy and run. Investigated: docs 50%. Fix: Add a copy-pasteable curl or SDK call, with the expected response, to the quickstart page (or its .md variant). | A quickstart is the fastest path from landing page to first successful call. |
| fail | Self-service developer portalvia docs | 0/29 | No self-service signup detected — no signup link on the homepage or docs, and no conventional signup path (/signup, /sign-up, /register, /get-started, /console/signup, /dashboard/signup, /try, /try-free, /free, /free-trial, /start, /start-free, /join, /create-account, /account/signup, /auth/signup, /users/sign_up) resolved — so an agent can't onboard on its own. Investigated: docs 0%. Fix: Publish a public signup endpoint and link it from your homepage/docs to compress time-to-first-call. | A first call without a human in the loop — self-serve credentials, a free tier, or an API that needs none. |
| na | Code samples in docs | —/18 | No surface produced evidence for this capability in this run. | Multi-language samples shorten time-to-first-call. |
Agent DiscoveryPartners and their agents can find your APIs — llms.txt, registries, crawlable and reachable docs3 pass0 warn1 fail75B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Docs reachable, not hard auth-gatedvia docs | 30/30 | All 1 pages are publicly accessible. Investigated: docs 100%. | Agents can only index and fetch docs they can reach — past auth gates and over correct HTTP semantics. |
| pass | Registry & SDK presencevia docs | 28/28 | Indexed on Context7 (websites/sonicwall_support_technical-documentation, 16590 snippets). Investigated: docs 100%, sdk 25%, cli 0%. | Listing in MCP registries and publishing SDKs puts the API where agents and their tooling look. |
| pass | Crawlable / AEOvia wellknown | 12/12 | robots.txt lets all monitored AI crawlers reach the docs paths. Investigated: wellknown 100%. | Bots allowed plus a fresh sitemap make docs findable by agent crawlers. |
| fail | llms.txt present, valid & comprehensivevia docs | 0/30 | No llms.txt found at any candidate location (https://www.sonicwall.com/support/technical-documentation/llms.txt, https://www.sonicwall.com/llms.txt, https://www.sonicwall.com/docs/llms.txt). Investigated: docs 0%, sdk 0%. | A valid, comprehensive llms.txt is the machine-readable entry point for agents. |
Agent UnderstandingAgents can correctly interpret your APIs — machine-readable errors, consistent descriptions, structured data, parseable docs1 pass2 warn1 fail61C
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Agent-navigable, token-efficient docsvia docs | 22/22 | All 1 pages contain server-rendered content. Investigated: docs 100%. | Server-rendered, clean, small-footprint docs are what an agent can cheaply fetch and parse correctly. |
| warn | Operation purpose clarityvia sdk | 15/25 | Read/write classification is mostly ambiguous: only 1/5 operations classified. Investigated: sdk 60%, spec 0%. Fix: Use standard verbs (get/list/create/update/delete) and clear mutation semantics so agents can tell reads from writes. | Agents select the right endpoint from its summary + operationId; clear, named operations make tool-selection reliable — the strongest driver of correct tool choice. |
| warn | Agent instructions file (AGENTS.md)via sdk | 5/10 | No agents.md or skill.md context file found (nice-to-have for agent operation). Investigated: sdk 50%, wellknown 0%. Fix: Add an agents.md or skill.md describing how an agent should use this SDK (auth setup, key operations, gotchas). | An AGENTS.md gives coding agents explicit setup, auth, and usage instructions to interpret and operate the API — beyond llms.txt's link index. |
| fail | Machine-readable errors (RFC 9457)via spec | 0/28 | No error responses (4xx/5xx or a catch-all default) are documented anywhere in the spec, so an agent can't anticipate or handle failures. Investigated: spec 0%, docs 0%. Fix: Document at least the common error codes (400, 401, 403, 404, 429, 500) per operation. | RFC 9457 problem details and a documented error-code inventory let agents parse failures without burning tokens. |
| na | Docs structured data | —/8 | No surface produced evidence for this capability in this run. | Structured data (JSON-LD/schema.org) on docs pages gives agents an unambiguous parse target and is what answer engines cite. Detected on the JS-rendered head (Firecrawl) for a bounded page budget, so JS-injected JSON-LD is now caught; pages we can't render are excluded rather than failed. |
| na | Description consistency across surfaces | —/7 | Only 0 surface description(s) with ≥6 tokens available; need at least 2 to compare. | Every surface tells the same story about what the product is. |
Agent UsabilityAgents have the context to use your APIs reliably, not just find them5 pass0 warn0 fail100A+
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Idempotency documentedvia spec | 27/27 | idempotency is documented on the docs site at https://www.sonicwall.com/api/idempotency, even though it isn't declared in the API spec. Investigated: spec 100%, docs 100%, sdk 0%. | Documented idempotency lets agents retry safely. |
| pass | Rate-limit signalingvia spec | 22/22 | rate-limit behavior is documented on the docs site at https://www.sonicwall.com/api/rate-limits, even though it isn't declared in the API spec. Investigated: spec 100%, docs 100%. | Machine-readable rate-limit headers let agents throttle adaptively. |
| pass | Pagination documented & consistentvia docs | 22/22 | pagination is documented on the docs site at https://www.sonicwall.com/api/pagination, even though it isn't declared in the API spec. Investigated: docs 100%, spec 50%. | Consistent, documented pagination lets agents traverse collections. |
| pass | Sandbox separationvia spec | 20/20 | sandbox is documented on the docs site at https://www.sonicwall.com/api/sandbox, even though it isn't declared in the API spec. Investigated: spec 100%, docs 100%, sdk 50%. | An isolated environment lets agents exercise destructive operations safely. |
| pass | Runnable collection with test scriptsvia sdk | 9/9 | README is present and includes a runnable quickstart. Investigated: sdk 100%, platform 0%. | A public, maintained collection with assertions is runnable truth agents validate against. |
Resources Discovered
The public resources we found for Sonicwall — the evidence behind the score. All discovered from public sources; nothing here requires access to your systems.
| Agent hints | Context7 (16,590) |
|---|---|
| APIs analyzed | 1 — RESTAPI Core V1 |