FerryDocs
ContributingWeb client

Requests to the API

The dashboard uses only the public REST API, like the CLI. The browser sends the session cookie with each request.

Edit on GitHub
JSON + cookieA pagequery or mutationclient.tswraps fetchferryd/api/v1/*ApiErrorfrom an error body

A query or a mutation of a page calls client.ts.

1 / 3

The dashboard uses only the public REST , like the CLI. See the API overview.

The rules of a request

SubjectRule
FormatA or a is a JSON call to /api/v1/*.
OriginThe call goes to the same . Thus is not necessary.
ProofThe browser sends the by itself. The app sets no Authorization header.
Errorssrc/lib/api/client.ts wraps fetch. It changes an error body into ApiError { status, code, message }.

Sign-in and the session describes the cookie. Live updates describes the streams.

On this page