ReferenceAPI overview
Paths of the server
ferryd serves the API, its documents, the webhooks and the dashboard on different paths.
/api/v1/… the REST API
/api/openapi.json the OpenAPI 3.1 document
/api/docs Swagger UI
/hooks/deploy/{service_id} deploy hooks
/hooks/github the GitHub webhook
/healthz liveness probe
anything else the web dashboardEach path has its own authentication.
The paths
| Path | What it is | Authentication |
|---|---|---|
/api/v1/… | The REST API | An API token or the session of the dashboard. A few account endpoints need none. |
/api/openapi.json | The OpenAPI document, version 3.1 | None |
/api/docs | Swagger UI for your server | None. Its Authorize button takes an API token. |
/hooks/deploy/{service_id} | Deploy hooks | The key of the hook |
/hooks/github | GitHub webhook | The signature of the webhook |
/healthz | A liveness probe. It answers ok. | None |
| All other paths | The web dashboard | None. The dashboard asks you to sign in. |