This install, and updating it
What this install is, the release the hourly check found, and applying it (docs/updating.md). Writes are refused with 503 while an update is in flight.
Reading needs Read only and changes need Full, unless an endpoint says otherwise. How to read this page.
GET /api/system/version
Section titled “GET /api/system/version”This version and channel, the newest known release, and when it was last checked.
- Level: Read only
- Returns:
{version, gitSha, channel, source, latest, updateAvailable, checkedAt, nextCheckAt, error}
GET /api/system/about
Section titled “GET /api/system/about”Where this install came from and what it runs on - the About page in one call.
- Level: Read only
- Returns:
{repoUrl, host, publicIp, reverseDns, communityUrl, panelDomain, node, panelUptimeSeconds}
POST /api/system/update/check
Section titled “POST /api/system/update/check”Ask GitHub now instead of waiting for the hourly check.
- Level: Manage. Only asks GitHub now instead of within the hour
- Returns:
the same object as GET /api/system/version
POST /api/system/update
Section titled “POST /api/system/update”Apply the release the check found; the panel goes away and comes back.
- Level: Full
- Notes: Destructive
- Input:
{version} - Returns:
202 {unit, version}
GET /api/system/update/status
Section titled “GET /api/system/update/status”Progress, log tail and history - keep polling through the gap where nothing answers.
- Level: Read only
- Returns:
{running, maintenance, state, log, history}
POST /api/system/update/post-update
Section titled “POST /api/system/update/post-update”Re-run the follow-up tasks of the last applied update.
- Level: Full
- Notes: Job