Edge administration
Inspect and adopt existing edge sites on a self-hosted installation.
Inspect or adopt sites already managed by the edge proxy on a self-hosted installation. The SDK exposes
site inspection and removal through ship.system; imports and installation preflight remain HTTP-only. Use domains for project hostnames and
servers for edge component installation and updates.
Inspect existing sites
const scan = await ship.system.listUntrackedEdgeSites();
console.log(scan.scanned, scan.orphans);curl "$SYNQ_URL/api/system/edge/untracked" \
-H "Authorization: Bearer $SYNQ_TOKEN"Site inspection and removal require installation administrator authority. Review discovered sites before importing or removing them. Importing associates supported sites with Synq projects; removing an untracked site changes the host's edge configuration.
Installation edge preflight
POST /api/system/self-edge/preflight checks the edge configuration needed to expose Synq itself.
It is separate from attaching a domain to an application project.
For the interactive workflow and command options, see the Edge guide and CLI edge reference.
Operations
Resource methods
| Operation | SDK | REST API |
|---|---|---|
| List edge sites not tracked by project records. | system.listUntrackedEdgeSites() | GET /api/system/edge/untrackedsettings:read |
| Remove an authorized untracked edge site. | system.removeUntrackedEdgeSite(input) | POST /api/system/edge/untracked/removesettings:admin |
HTTP endpoints
| Operation | SDK | REST API |
|---|---|---|
| Import discovered edge sites. | HTTP only | POST /api/system/edge/import-sitesInternal operator · Self-hosted |
Publish the routes of this server's deployed apps once its edge is on (run by synq edge on). | HTTP only | POST /api/system/edge/reapply-routesInternal operator · Self-hosted |
| Check edge readiness for the Synq installation itself. | HTTP only | POST /api/system/self-edge/preflightInternal operator · Self-hosted |