Authentication

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

The CLI, scripts and CI send an API token as a bearer token.

1 / 3

authentication is the proof of who sends a request. A /api/v1 request has one of two proofs.

Send a token

Terminal

curl -H "Authorization: Bearer $FERRY_TOKEN" http://127.0.0.1:7878/api/v1/services

Proof	Who uses it	How
An API token	The CLI, scripts and CI	As a bearer token, in the `Authorization` header
The session cookie	The dashboard	The browser gets it when you sign in with the email and the password of the account.

The name of the cookie is ferry_session_<port>. The port is the port of the address that the browser uses.

API reference and OpenAPI

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

API tokens

An API token is fy_ and 40 hex characters. There are three kinds, all with the same access.