API Reference
REST API reference for the Propeller WebAssembly orchestrator. Manage tasks, jobs, proplets, DAG workflows, and federated learning experiments via the Manager REST API.
The Propeller Manager exposes a REST API for managing distributed workloads. Download the Postman collection to explore the API interactively.
Core APIs
- Health - Health check endpoint
- Metrics - Prometheus metrics endpoint
- Proplets - Manage proplet workers
- Tasks - Create and manage tasks
- Jobs - Manage task execution jobs
- Workflows - Deploy multi-task workflows (DAGs)
Federated Learning
The FL API enables federated machine learning across distributed proplets. See Federated Learning for architecture and usage details.
| Endpoint | Description |
|---|---|
| POST /fl/experiments | Configure and start an FL experiment |
| GET /fl/task | Get FL task details for a proplet |
| POST /fl/update | Submit training updates (JSON) |
| POST /fl/update_cbor | Submit training updates (CBOR) |
| GET /fl/rounds/{round_id}/complete | Check round completion status |