Skip to the content.

System Management API

All endpoints require JWT Authentication.

1. Dashboard Summary

Get overview of system status, channels, northbound status, and resource usage.

Response:

{
  "channels": [ ... ],
  "northbound": [ ... ],
  "edge_rules": { ... },
  "system": {
    "cpu_usage": 12.5,
    "memory_usage": 512,
    "disk_usage": 45.5,
    "goroutines": 120
  }
}

2. Get System Configuration

Get full system configuration including Network, Time, HA, and LDAP settings.

Response: SystemConfig object (see internal/model/system.go).

3. Update System Configuration

Update system configuration.

Request Body: SystemConfig object.

Response:

{
  "status": "success",
  "message": "System configuration updated"
}

4. Restart System

Triggers a system restart (gateway process exit).

Response:

{
  "status": "success",
  "message": "System is restarting..."
}

5. Network Interfaces

Get list of available network interfaces.

Response: Array of NetworkInterface objects.

6. Network Routes

Get list of static routes.

Response: Array of StaticRoute objects.