Reference
API overview
The dashboard and the CLI use one JSON REST API. These pages give the rules of all its endpoints.
The CLI, the dashboard and your scripts all use the same API.
1 / 4
All that the dashboard and the ferry CLI do goes through one JSON REST API. ferryd serves it.
These pages give the rules that each endpoint follows. The API reference describes the endpoints one by one.
Send a first request
The examples use curl.
# On the server itself: the server token. Elsewhere, an API token created in the dashboard.
export FERRY_TOKEN="$(cat ferry-data/api_token)"
curl -H "Authorization: Bearer $FERRY_TOKEN" http://127.0.0.1:7878/api/v1/info