FerryDocs
ReferenceAPI reference

Server info

Server info, liveness and the OpenAPI document.

Server info

GET/api/v1/info

Version, base domain and default domain, proxy and dashboard URLs, TLS and GitHub webhook status, Docker version. Clients use it to validate a token.

Authorization

AuthorizationBearer <token>

An API token: one created in the dashboard or by ferry login, or the server token stored in <data-dir>/api_token. GET requests may send it as ?access_token= instead.

In: header

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/info" \  -H "Authorization: Bearer $FERRY_TOKEN"
{  "base_domain": "string",  "dashboard_url": "string",  "default_cpu_limit": 0.1,  "default_domain": "string",  "default_memory_limit_mb": 0,  "docker_cpus": 0,  "docker_memory_bytes": 0,  "docker_version": "string",  "github_webhook_enabled": true,  "proxy_url": "string",  "tls_enabled": true,  "version": "string"}

Liveness probe

GET/healthz

Answers ok while the server runs. No token needed.

Response Body

text/plain

curl -X GET "https://example.com/healthz"
"ok"

This OpenAPI document

GET/api/openapi.json

The OpenAPI 3.1 document of this API, as JSON. No token needed; Swagger UI at /api/docs renders it.

Response Body

application/json

curl -X GET "https://example.com/api/openapi.json"
{}

API reference

Every endpoint of the Ferry HTTP API, generated from the OpenAPI 3.1 document that ferryd serves.

auth

The account of the server (its administrator), signing in and out of the dashboard, the sessions and the API tokens, and ferry login (a terminal asks, the dashboard approves). The status, the first-run setup, signing in and out, and the two calls of a terminal need no authentication; the others only accept the dashboard's session, never an API token.