Manage servers, Docker containers, stacks, builds, and procedures via Komodo Core API.
Prerequisites
Set environment variables:
KOMODO_ADDRESS- Komodo Core URL (e.g.,https://komodo.example.com)KOMODO_API_KEY- API key (starts withK-)KOMODO_API_SECRET- API secret (starts withS-)
Quick Reference
# Set env (or source from credentials file)
export KOMODO_ADDRESS="https://komodo.weird.cyou"
export KOMODO_API_KEY="K-..."
export KOMODO_API_SECRET="S-..."
List resources
python scripts/komodo.py servers python scripts/komodo.py deployments python scripts/komodo.py stacks python scripts/komodo.py builds python scripts/komodo.py procedures python scripts/komodo.py repos
Server operationspython scripts/komodo.py server python scripts/komodo.py server-stats
Deployment operationspython scripts/komodo.py deployment python scripts/komodo.py deploy python scripts/komodo.py start python scripts/komodo.py stop python scripts/komodo.py restart python scripts/komodo.py logs [lines]
Stack operationspython scripts/komodo.py stack python scripts/komodo.py deploy-stack python scripts/komodo.py start-stack python scripts/komodo.py stop-stack python scripts/komodo.py restart-stack python scripts/komodo.py create-stack <compose.yml> [env_file] python scripts/komodo.py delete-stack python scripts/komodo.py stack-logs [service]
Build operationspython scripts/komodo.py build python scripts/komodo.py run-build
Procedure operationspython scripts/komodo.py procedure python scripts/komodo.py run-procedure
## State Indicators
- 🟢 Running/Ok
- 🔴 Stopped
- ⚪ NotDeployed
- 🟡 Unhealthy
- 🔄 Restarting
- 🔨 Building
- ⏳ Pending
## Direct API Calls
For operations not covered by the CLI, use curl:
```bash
# Read operation
curl -X POST "$KOMODO_ADDRESS/read/ListServers" \
-H "Content-Type: application/json" \
-H "X-Api-Key: $KOMODO_API_KEY" \
-H "X-Api-Secret: $KOMODO_API_SECRET" \
-d '{}'
# Execute operation
curl -X POST "$KOMODO_ADDRESS/execute/Deploy" \
-H "Content-Type: application/json" \
-H "X-Api-Key: $KOMODO_API_KEY" \
-H "X-Api-Secret: $KOMODO_API_SECRET" \
-d '{"deployment": "my-deployment"}'
API Reference
Read endpoints: ListServers, ListDeployments, ListStacks, ListBuilds, ListProcedures, ListRepos, GetSystemStats, GetLog
Execute endpoints: Deploy, StartDeployment, StopDeployment, RestartDeployment, DeployStack, StartStack, StopStack, RestartStack, RunBuild, RunProcedure
Full API docs: https://komo.do/docs