ReferenceAPI reference
Change feed
The change feed (Server-Sent Events) the web client uses to stay current without polling.
GET
/api/v1/eventsTells a client what changed so it refetches only that: API writes are reported at once, the engine's own changes (deploy progress, datastore provisioning, cron runs) within about a second.
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
text/event-stream
application/json
application/json
curl -X GET "https://example.com/api/v1/events" \ -H "Authorization: Bearer $FERRY_TOKEN""event: ready\ndata: {}\n\nevent: change\ndata: {\"kind\":\"deploy\",\"id\":\"dep-01j9\",\"service_id\":\"srv-01j8\",\"action\":\"updated\"}\n\n"