API Reference

API Reference

DevAll exposes REST endpoints and WebSocket communication for service control.

REST API

Base URL: http://localhost:7777/api

Service Control

GET /api/services

Get all services and their status.

curl http://localhost:7777/api/services

Response:

{
  "services": [
    {
      "id": "api",
      "name": "API Server",
      "status": "running",
      "port": 3000,
      "pid": 12345
    }
  ]
}

POST /api/services/:id/start

Start a service.

curl -X POST http://localhost:7777/api/services/api/start

POST /api/services/:id/stop

Stop a service.

curl -X POST http://localhost:7777/api/services/api/stop

POST /api/services/:id/restart

Restart a service.

curl -X POST http://localhost:7777/api/services/api/restart

DELETE /api/services/:id/logs

Clear service logs.

curl -X DELETE http://localhost:7777/api/services/api/logs

Configuration

GET /api/config

Get current configuration.

curl http://localhost:7777/api/config

PUT /api/services/:id

Update service configuration.

curl -X PUT http://localhost:7777/api/services/api \
  -H "Content-Type: application/json" \
  -d '{"port": 3001, "autostart": true}'

System

GET /api/health

Health check endpoint.

curl http://localhost:7777/api/health

Response:

{
  "status": "ok",
  "uptime": 3600,
  "services": 5
}

GET /api/resources

Get system resource usage.

curl http://localhost:7777/api/resources

Response:

{
  "cpu": {
    "usage": 45.2,
    "cores": 8
  },
  "memory": {
    "used": 4294967296,
    "total": 17179869184,
    "percentage": 25
  }
}

WebSocket Protocol

Connect to: ws://localhost:7777/ws

Client → Server Messages

Terminal Input

Send input to terminal services:

{
  "type": "terminal-input",
  "serviceId": "terminal-1",
  "data": "ls -la\n"
}

Command Execution

Execute commands:

{
  "type": "command",
  "action": "start",
  "serviceId": "api"
}

Server → Client Messages

Initial State

Sent immediately after connection:

{
  "type": "init",
  "services": [...],
  "logs": {...}
}

Status Update

Service status changes:

{
  "type": "status",
  "serviceId": "api",
  "status": "running",
  "pid": 12345
}

Log Output

Service output:

{
  "type": "log",
  "serviceId": "api",
  "level": "info",
  "message": "Server started on port 3000",
  "timestamp": "2024-01-20T10:30:00Z"
}

Resource Update

System metrics:

{
  "type": "resource-update",
  "cpu": 45.2,
  "memory": 4294967296,
  "services": {
    "api": {
      "cpu": 12.5,
      "memory": 536870912
    }
  }
}

Configuration Update

Config changes:

{
  "type": "config-update",
  "serviceId": "api",
  "config": {
    "port": 3001,
    "autostart": true
  }
}

Error Codes

Code	Description
200	Success
400	Bad request
404	Service not found
409	Service already running
500	Internal server error

Rate Limiting

• No rate limiting on REST endpoints
• WebSocket messages are throttled to 100/second per client
• Log batching occurs at 16ms intervals

Authentication

Currently no authentication required. DevAll is designed for local development only.

Security Note: Do not expose DevAll ports to the internet. Use tunneling services (ngrok) for secure external access.

Client Libraries

JavaScript/TypeScript

// WebSocket connection
const ws = new WebSocket('ws://localhost:7777/ws');

ws.onmessage = (event) => {
  const data = JSON.parse(event.data);
  console.log('Received:', data);
};

// REST API
fetch('http://localhost:7777/api/services')
  .then(res => res.json())
  .then(data => console.log(data));

Python

import websocket
import requests

# REST API
response = requests.get('http://localhost:7777/api/services')
print(response.json())

# WebSocket
def on_message(ws, message):
    print(f"Received: {message}")

ws = websocket.WebSocketApp("ws://localhost:7777/ws",
                            on_message=on_message)
ws.run_forever()

CLI Usage

# Using curl
curl http://localhost:7777/api/services | jq

# Using websocat for WebSocket
websocat ws://localhost:7777/ws