Backend API¶
Endpoints¶
Auth¶
| Method | Path | Description |
|---|---|---|
| GET | /api/auth/status |
Check authentication status |
| POST | /api/auth/github |
Exchange GitHub OAuth code for JWT tokens |
| POST | /api/auth/refresh |
Refresh an expired access token |
| GET | /api/auth/me |
Get current authenticated user |
Workspaces¶
| Method | Path | Description |
|---|---|---|
| GET | /api/workspaces |
List registered workspaces |
| POST | /api/workspaces |
Register a new cutip workspace |
| GET | /api/workspaces/{id} |
Get workspace details |
| DELETE | /api/workspaces/{id} |
Unregister a workspace |
Artifacts¶
| Method | Path | Description |
|---|---|---|
| GET | /api/workspaces/{id}/artifacts |
List all artifacts in workspace |
| GET | /api/workspaces/{id}/artifacts/groups/{name} |
Get group detail + YAML |
| GET | /api/workspaces/{id}/artifacts/units/{name} |
Get unit detail + YAML |
| GET | /api/workspaces/{id}/artifacts/cards/{name} |
Get card detail + YAML |
| POST | /api/workspaces/{id}/artifacts/validate |
Run graph validation |
| GET | /api/workspaces/{id}/artifacts/dag |
Get DAG data for visualization |
Containers (plugin: container-runtime)¶
| Method | Path | Description |
|---|---|---|
| GET | /api/containers |
List containers |
| GET | /api/containers/{id} |
Inspect container |
| POST | /api/containers/{id}/start |
Start container |
| POST | /api/containers/{id}/stop |
Stop container |
| POST | /api/containers/{id}/restart |
Restart container |
| DELETE | /api/containers/{id} |
Remove container |
| GET | /api/containers/{id}/logs |
Get container logs |
| WS | /api/containers/{id}/exec |
Interactive shell |
Images (plugin: container-runtime)¶
| Method | Path | Description |
|---|---|---|
| GET | /api/images |
List images |
| GET | /api/images/{id} |
Inspect image |
| POST | /api/images/pull |
Pull an image |
| DELETE | /api/images/{id} |
Remove image |
Volumes (plugin: container-runtime)¶
| Method | Path | Description |
|---|---|---|
| GET | /api/volumes |
List volumes |
| GET | /api/volumes/{name} |
Inspect volume |
| POST | /api/volumes |
Create volume |
| DELETE | /api/volumes/{name} |
Remove volume |
Networks (plugin: container-runtime)¶
| Method | Path | Description |
|---|---|---|
| GET | /api/networks |
List networks |
| GET | /api/networks/{name} |
Inspect network |
| POST | /api/networks |
Create network |
| DELETE | /api/networks/{name} |
Remove network |
System¶
| Method | Path | Description |
|---|---|---|
| GET | /api/health |
Health check |
| GET | /api/system/info |
System info (OS, arch, container counts) |
| GET | /api/system/backends |
List available container backends |
| GET | /api/system/disk-usage |
Disk usage breakdown |
| POST | /api/system/prune |
Prune unused objects |
| GET | /api/system/plugins |
List enabled plugins |
| GET | /api/system/cutip-projects |
Map workspaces to cutip projects |
| GET | /api/system/log-path |
Backend log file path |
| GET | /api/system/logs |
Read backend log file (tail) |
Settings¶
| Method | Path | Description |
|---|---|---|
| GET | /api/settings/setup-required |
Check if initial setup is needed |
| GET | /api/settings/api-keys |
List API keys |
| POST | /api/settings/api-keys |
Add an API key |
| DELETE | /api/settings/api-keys/{id} |
Delete an API key |
| POST | /api/settings/api-keys/verify |
Verify an API key |
Terminal (plugin: container-runtime)¶
| Method | Path | Description |
|---|---|---|
| WS | /api/terminal/compose-logs |
Stream live container events |