Reference: API, CLI and the rest of the record

This section is the record you check rather than read start to finish: the API and CLI surfaces, the terms the rest of the docs use, and the standing statements on what downpipes will and will not claim. Two subsections group the largest parts of it; everything else sits at the top level.

API

The engine’s HTTP surface, for a developer integrating directly or an operator reading the audit feed into a SIEM. Start at the API overview for the conventions every endpoint follows, then go to the admin endpoint catalogue, authentication and authorisation, sign-in flows, restore and recovery, or support diagnostics and audit-feed pull endpoints.

CLI

The offline reader and provisioner shipped as the open-source downpipe binary. Start at the CLI command reference for every flag, then exit codes and verification outcomes for what a drill script should check.

Everything else

• Glossary: precise definitions of the terms used across these docs.
• Engine error and status codes and troubleshooting.
• Changelog and versioning.
• How downpipe relates to the proprietary engine: the source-available and open-source boundary, stated exactly.
• Precise claims and the honesty posture: the wording behind every claim these docs make.
• Accessibility statement.
• Use these docs in your AI tools: the MCP search server, llms.txt and the OpenAPI spec, for a coding agent or an AI-assisted workflow.

Last updated 6 July 2026.