API Reference¶
Public API service (ft.api.app)¶
Base URL (local): http://localhost:8000
Health and observability¶
| Method | Path | Auth | Notes |
|---|---|---|---|
GET |
/health |
No | Liveness probe |
GET |
/health/ready |
No | DB readiness check |
GET |
/metrics |
No | Prometheus metrics |
Assets¶
| Method | Path | Auth | Notes |
|---|---|---|---|
GET |
/api/v1/assets/{asset_id} |
X-API-Key |
Asset card |
GET |
/api/v1/assets/{asset_id}/owners |
X-API-Key |
Current owners |
Collections¶
| Method | Path | Auth | Notes |
|---|---|---|---|
GET |
/api/v1/collections/{collection_id} |
X-API-Key |
Collection stats |
GET |
/api/v1/collections/{collection_id}/assets |
X-API-Key |
Assets in collection |
GET |
/api/v1/collections/{collection_id}/listings |
X-API-Key |
Listings for collection |
Auth header for protected routes:
X-API-Key: <plain_api_key>
Service admin panel (ft.admin_panel.app)¶
Base URL (local): http://localhost:8010
Authentication:
- HTTP Basic auth (username/password from
ADMIN_PANEL_USERNAMEandADMIN_PANEL_PASSWORD).
| Method | Path | Auth | Notes |
|---|---|---|---|
GET |
/health |
No | Liveness probe |
GET |
/ |
Basic | HTML dashboard |
GET |
/api/overview |
Basic | Overview counters |
GET |
/api/networks |
Basic | Network cursors |
GET |
/api/outbox/topics |
Basic | Pending outbox by topic |
GET |
/api/dlq |
Basic | DLQ rows |
GET |
/api/dashboard |
Basic | Combined dashboard snapshot |
OpenAPI UIs¶
- API Swagger UI:
/docs - Admin panel Swagger UI:
/docs