Overview

This reference covers the Putty Engine's HTTP API, in two kinds of page that sit side by side: written pages, and one generated page for every operation.

What this reference covers

The Engine is reached over HTTP. Every route accepts a request that the server validates against a schema and returns either a result or one of the failures the route documents. Each route is described that way here — the fields it accepts, the status codes it can answer with, and the shape of the body it sends back — so a client can be written from these pages without reading the server.

Nothing on these pages is invented. The generated pages are rendered from the OpenAPI document the API app publishes, so they cannot drift from the routes the server registers.

How the sidebar is organised

• Overview — this page.
• API Reference — the generated pages, one per operation, grouped by the tag the operation carries on the server.

Every page has a Markdown copy behind the buttons above its body, and any page can be fetched as Markdown by suffixing its URL with .md.