Core Operations
The procedures scripts and integrations use most.
The API namespace mirrors the CLI and MCP tools. The procedures below are the stable operations most integrations start with; the full, generated list lives in the in-dashboard API Documentation.
Services#
| Procedure | Purpose |
|---|---|
service.list | Services in scope (optionally by project/environment) |
service.get | One service with its source and state |
service.deploy | Trigger a deployment (respects deploy windows) |
service.status | Deployment state and last result |
service.restart / service.stop / service.start | Lifecycle operations |
service.scale | Set replicas |
service.delete | Remove with storage disposition |
Deployments and data#
| Procedure | Purpose |
|---|---|
deployment.logs | Build/runtime logs for a deployment |
backup.list / backup.run / backup.restore | Per-service backup lifecycle |
compose.overrides / compose.setOverrides | Read and replace compose overrides |
network.list / network.attach | Managed networks |
Platform#
| Procedure | Purpose |
|---|---|
system.status | Queue, transport and node health |
system.prune | Reclaim unused Docker resources |
org.members / org.roles | Membership management |
Permissions behave like the dashboard: each procedure asserts the caller's organization role and the granular member flags, and every mutating call is audit-logged. A token created by a Viewer cannot deploy, and a Member token without the relevant permission flag cannot touch automation.