API reference and OpenAPI

Your server gives the OpenAPI document of its API and a Swagger UI to try requests.

The OpenAPI document describes each endpoint of the API. Two tools read it.

Where to read and try the API

Tool	Where	Use
API reference	These docs	Each endpoint with its parameters, bodies and responses. It comes from the OpenAPI document.
OpenAPI document	`/api/openapi.json` on your server	For tools that read the OpenAPI 3.1 format.
Swagger UI	`/api/docs` on your server	To send requests from a browser.

The reference pages have no "try it" button, because ferryd sends no CORS headers.

http://127.0.0.1:7878/api/docs

Paste an API token.

Paths of the server

ferryd serves the API, its documents, the webhooks and the dashboard on different paths.

Authentication

Each request to /api/v1 needs an API token or the session cookie of the dashboard.