Libraries
Getting Started
Get an API key
Sign up at the Dedalus Dashboard and create an API key.
Authentication
All endpoints require a Bearer token orX-API-Key header, plus an X-Dedalus-Org-Id header.
Machines
| Method | Path | Description |
|---|---|---|
POST | /v1/machines | Create machine |
GET | /v1/machines | List machines |
GET | /v1/machines/:id | Get machine |
PATCH | /v1/machines/:id | Update machine |
DELETE | /v1/machines/:id | Destroy machine |
POST | /v1/machines/:id/wake | Wake machine |
POST | /v1/machines/:id/sleep | Sleep machine |
SSH
| Method | Path | Description |
|---|---|---|
POST | /v1/machines/:id/ssh | Create SSH session |
GET | /v1/machines/:id/ssh | List SSH sessions |
DELETE | /v1/machines/:id/ssh/:sid | Delete SSH session |
Executions
| Method | Path | Description |
|---|---|---|
POST | /v1/machines/:id/executions | Create execution |
GET | /v1/machines/:id/executions | List executions |
DELETE | /v1/machines/:id/executions/:eid | Delete execution |
Terminals
| Method | Path | Description |
|---|---|---|
POST | /v1/machines/:id/terminals | Create terminal |
GET | /v1/machines/:id/terminals/:tid/stream | Connect WebSocket |
Previews & Artifacts
| Method | Path | Description |
|---|---|---|
POST | /v1/machines/:id/previews | Create preview |
GET | /v1/machines/:id/artifacts | List artifacts |
GET | /v1/orgs/:org_id/usage | Get org usage |