Servers
Servers are bare metal or virtual machines where your workloads run. Each server has a Launcher agent installed that connects outbound to the control plane.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /api/v1/servers | List servers |
POST | /api/v1/servers | Add server |
GET | /api/v1/servers/:id | Get server |
PUT | /api/v1/servers/:id | Update server |
DELETE | /api/v1/servers/:id | Delete server |
POST | /api/v1/servers/:id/validate | Validate connectivity |
POST | /api/v1/servers/:id/ping | Ping server |
GET | /api/v1/servers/:id/agent-status | Get agent status |
POST | /api/v1/servers/:id/update-agent | Update agent software |
GET | /api/v1/servers/:id/tunnel-status | Get tunnel status |
GET | /api/v1/servers/tunnel-status/all | All tunnel statuses |
GET | /api/v1/servers/:id/diagnose | Run diagnostics |
POST | /api/v1/servers/:id/heal | Auto-heal detected issues |
GET | /api/v1/servers/:id/logs/storage | Log storage statistics |
GET | /api/v1/servers/:id/logs | Server runtime logs |
POST /api/v1/servers
{
"name": "prod-eu-1",
"ipAddress": "203.0.113.10",
"port": 22,
"username": "ubuntu",
"sshKeyId": "550e8400-e29b-41d4-a716-446655440000"
}Server Object
{
"id": "uuid",
"name": "prod-eu-1",
"ip_address": "203.0.113.10",
"port": 22,
"username": "ubuntu",
"ssh_key_id": "uuid",
"status": "active",
"agent_status": "connected",
"agent_id": "uuid",
"log_retention_days": 7,
"direct_ports_enabled": false,
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}Status Values
| Field | Values |
|---|---|
status | active, provisioning, error, offline |
agent_status | connected, disconnected, unknown |
Last updated on