Updates

Updated Nov 19, 2026 Markdown

GET /api/v1/system/packages/summary

OS package summary (counts only)

Cheap cached summary (no apt subprocess). Used by the topbar update badge.

Responses:

Status Schema Description
200 ApiSuccess_OsPackagesSummary_ Successful Response

Response example (200):

JSON
{
  "data": {
    "last_checked": "...",
    "reboot_required": false,
    "security_count": 0,
    "total": 0,
    "updates": [
      "..."
    ]
  },
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell
curl -X GET \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/system/packages/summary

GET /api/v1/system/packages/updates

List available OS package updates

Returns the apt/dnf update list (cached when an apply is in flight). The package index is read from the mirrors at most every 10 minutes; a check in between lists from the index on disk and answers the last listing again while neither the index nor the installed packages changed. Concurrent checks share one run. Each entry: name, current_version, candidate_version, security flag.

Responses:

Status Schema Description
200 ApiSuccess_list_OsPackageUpdate__ Successful Response

Response example (200):

JSON
{
  "data": [
    {
      "category": "...",
      "current_version": "...",
      "name": "...",
      "new_version": "..."
    }
  ],
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell
curl -X GET \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/system/packages/updates

POST /api/v1/system/packages/upgrade

Trigger OS package upgrade

Schedules an apt/dnf upgrade as a background job. Returns the initial status immediately — poll /upgrade/status for progress. Already-running jobs are surfaced without restart. Refused 409 while a guarded OS update run (the nightly run, a database update, a MariaDB series upgrade), a PHP version install or removal, or a web server plugin's activation, deactivation or update is in progress; the error code names what runs (OS_UPGRADE_IN_PROGRESS, PHP_PACKAGE_JOB_IN_PROGRESS, PLUGIN_TASK_IN_PROGRESS). A run that starts before the job does ends the job failed with nothing installed, and a run that starts while it works waits for it.

Body fields:

Field Type Required Notes
package_names array no Package names to upgrade. Each must match [a-z0-9][a-z0-9.+-]*
security_only boolean no default True

Request body example:

JSON
{
  "package_names": [
    "string"
  ],
  "security_only": true
}

Responses:

Status Schema Description
200 ApiSuccess_OsPackageApplyStatus_ Successful Response
422 HTTPValidationError Validation Error

Response example (200):

JSON
{
  "data": {
    "completed_at": "...",
    "error": "...",
    "fetch_failures": [
      "..."
    ],
    "message": "...",
    "output_tail": "",
    "progress": 0,
    "security_only": false,
    "stage": "idle",
    "started_at": "...",
    "target_packages": [
      "..."
    ],
    "upgraded": [
      "..."
    ]
  },
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell
curl -X POST \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  -H "Content-Type: application/json" \
  -d @body.json \
  https://your-server:2000/api/v1/system/packages/upgrade

GET /api/v1/system/packages/upgrade/history

OS upgrade history

Last N OS package upgrade attempts (limit 1–100, default 20; the file keeps at most 100).

Query parameters:

Name Type Required Notes
limit integer no minimum=1; maximum=100

Responses:

Status Schema Description
200 ApiSuccess_list_OsPackageApplyHistoryEntry__ Successful Response
422 HTTPValidationError Validation Error

Response example (200):

JSON
{
  "data": [
    {
      "completed_at": "...",
      "error_message": "...",
      "fetch_failures": "...",
      "id": "...",
      "security_only": "...",
      "started_at": "...",
      "status": "...",
      "target_packages": "...",
      "upgraded": "..."
    }
  ],
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell
curl -X GET \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/system/packages/upgrade/history

GET /api/v1/system/packages/upgrade/status

Get OS upgrade job status

Poll-friendly endpoint. Survives page navigation — the job runs server-side even if the client disconnects. A finished job stays here until the next job or /upgrade/status/dismiss; a failed one names the downloads behind it in fetch_failures (repository host, HTTP status, file count) beside the package manager's last line in error.

Responses:

Status Schema Description
200 ApiSuccess_OsPackageApplyStatus_ Successful Response

Response example (200):

JSON
{
  "data": {
    "completed_at": "...",
    "error": "...",
    "fetch_failures": [
      "..."
    ],
    "message": "...",
    "output_tail": "",
    "progress": 0,
    "security_only": false,
    "stage": "idle",
    "started_at": "...",
    "target_packages": [
      "..."
    ],
    "upgraded": [
      "..."
    ]
  },
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell
curl -X GET \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/system/packages/upgrade/status

POST /api/v1/system/packages/upgrade/status/dismiss

Dismiss the finished OS upgrade's outcome

Returns the live status of a finished job (completed or failed) to idle, so the panel stops showing its outcome for every administrator; the record stays in /upgrade/history. Answers the idle status when there is nothing to dismiss. Refused 409 OS_UPGRADE_IN_PROGRESS while a job runs.

Responses:

Status Schema Description
200 ApiSuccess_OsPackageApplyStatus_ Successful Response

Response example (200):

JSON
{
  "data": {
    "completed_at": "...",
    "error": "...",
    "fetch_failures": [
      "..."
    ],
    "message": "...",
    "output_tail": "",
    "progress": 0,
    "security_only": false,
    "stage": "idle",
    "started_at": "...",
    "target_packages": [
      "..."
    ],
    "upgraded": [
      "..."
    ]
  },
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell
curl -X POST \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/system/packages/upgrade/status/dismiss

GET /api/v1/system/update/changelog

Get cached changelog

Returns the changelog the last update check answered — the same text /check returns in its changelog field. Null before any check and for a host already on the latest version (the vendor sends no changelog then); a message accompanies the former. Response data: {changelog}.

Responses:

Status Schema Description
200 ApiSuccess_dict_str__Any__ Successful Response

Response example (200):

JSON
{
  "data": {},
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell
curl -X GET \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/system/update/changelog

GET /api/v1/system/update/check

Check for WHost agent updates

Check whether a newer WHost agent release is available and return the changelog. Result is cached server-side until the next check.

Responses:

Status Schema Description
200 ApiSuccess_UpdateCheckResult_ Successful Response

Response example (200):

JSON
{
  "data": {
    "beta_denied": false,
    "changelog": "...",
    "channel": "string",
    "current_version": "string",
    "error": "...",
    "is_mandatory": false,
    "last_checked": "...",
    "latest_version": "string",
    "min_version": "...",
    "requires_restart": true,
    "size_bytes": "...",
    "update_available": false
  },
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell
curl -X GET \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/system/update/check

GET /api/v1/system/update/history

List past update operations

Returns every update install attempt (newest first), including stage outcome + duration.

Responses:

Status Schema Description
200 ApiSuccess_list_UpdateHistoryEntry__ Successful Response

Response example (200):

JSON
{
  "data": [
    {
      "backup_path": "...",
      "completed_at": "...",
      "error_message": "...",
      "from_version": "...",
      "id": "...",
      "recipes_delivered": "...",
      "started_at": "...",
      "status": "...",
      "to_version": "...",
      "type": "..."
    }
  ],
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell
curl -X GET \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/system/update/history

POST /api/v1/system/update/install

Trigger WHost update install

Starts the install pipeline in the background. Returns immediately ({started: true}); poll /status or open /status/stream (SSE) to follow progress. Refused 409 UPDATE_IN_PROGRESS while a run is going, 409 BACKUP_IN_PROGRESS while a backup, a restore or a scheduled backup runs in the agent (the run ends in a restart that would cut it; the message names the work and when it started), 400 UPDATE_CHECK_REQUIRED before any /check has run in this agent process, 400 UPDATE_ALREADY_LATEST when the last check found no newer version, 400 UPDATE_DOWNGRADE_REJECTED when the offered release orders before the installed one, 400 UPDATE_INVALID_VERSION when the offered version is not a version. All six are answered before anything starts; backup work that starts between this answer and the run's first step ends the run as failed with the same message.

Responses:

Status Schema Description
200 ApiSuccess_dict_str__Any__ Successful Response

Response example (200):

JSON
{
  "data": {},
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell
curl -X POST \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/system/update/install

GET /api/v1/system/update/os-security

OS security updates installed on their own

The os_packages_auto_security setting as it stands on this server: setting (null = never saved, the operating system's default applies; os_default_installs says whether that default installs security updates), the OS tool that installs them (tool), whether the files WHost writes match the setting (in_place), a change being applied (applying) or the error of the last application (apply_error), the next run (next_run_at), the last run and the last run that installed packages (last_run, last_install: unit, window, outcome installed | nothing | failed | skipped, packages, error), whether a restart is pending (reboot_required) and the night restart (reboot: setting null = never saved, the window time in the server's timezone, in_place, apply_error, whether the operating system asks for a restart now and the packages that ask, the next window next_at, blocked when a restart was already made for the same packages, last_attempt (skipped with reason backup | update | migration, blocked, failed) and last_restart (kernels before / expected / after, services checked and the ones not running, outcome pending | done | problem)).

Responses:

Status Schema Description
200 ApiSuccess_OsAutoSecurityStatus_ Successful Response

Response example (200):

JSON
{
  "data": {
    "apply_error": "...",
    "applying": false,
    "database": "...",
    "family": "debian",
    "guarded": false,
    "in_place": true,
    "last_check": "...",
    "last_install": "...",
    "last_run": "...",
    "locks": [
      "..."
    ],
    "manual": [
      "..."
    ],
    "mode": "security",
    "next_run_at": "...",
    "os_default_installs": false,
    "reboot": "...",
    "reboot_required": false,
    "running_since": "...",
    "runs": [
      "..."
    ],
    "setting": "...",
    "tool": "string"
  },
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell
curl -X GET \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/system/update/os-security

POST /api/v1/system/update/os-security/database

Install the database updates left for a manual run

Dumps every database (kept under /var/lib/whost/os-update/db-backups, the last three), then runs the guarded update for the database group with its updates outside security included — within the installed series only; a move to another series is not made here. Checked and put back like any group; the result is a run with trigger database.

Responses:

Status Schema Description
200 ApiSuccess_dict_str__str__ Successful Response

Response example (200):

JSON
{
  "data": {},
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell
curl -X POST \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/system/update/os-security/database

GET /api/v1/system/update/os-security/database/series

The next MariaDB series and what upgrading to it takes

The installed MariaDB (version, series), the next long-term support series still supported (target, its end of support target_eol) and where it comes from (source distro — the distribution's repositories, an AppStream module stream on the RHEL family — or mariadb, MariaDB's repository for that series at repository, added by the run), the data folder and its size, the free disk and the disk the run needs (a copy of the data folder, a dump, the packages), the estimated time the databases are read-only and how many sites the check samples. blockers lists what stops a start (not-installed, latest, no-source, disk, no-client-file, not-running, running, backup); can_start is true without one. The source is looked up on the network; the answer is kept five minutes.

Responses:

Status Schema Description
200 ApiSuccess_OsDbSeriesPlan_ Successful Response

Response example (200):

JSON
{
  "data": {
    "blockers": [
      "..."
    ],
    "can_start": false,
    "data_bytes": 0,
    "datadir": "...",
    "estimated_seconds": 0,
    "free_bytes": 0,
    "repository": "...",
    "required_bytes": 0,
    "series": "...",
    "sites": 0,
    "source": "...",
    "target": "...",
    "target_eol": "...",
    "version": "..."
  },
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell
curl -X GET \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/system/update/os-security/database/series

POST /api/v1/system/update/os-security/database/series

Upgrade MariaDB to the next series, checked and put back on a failure

Starts whost-os-update db-series in a unit of its own for the series target the plan names (422 for another one or while a blocker stands; 409 OS_UPGRADE_IN_PROGRESS while an OS update run or package work started from the panel runs - an OS package upgrade, a PHP version job, a web server plugin's work -, 409 BACKUP_IN_PROGRESS while backup work runs). The run keeps the files of the installed database packages, downloads the new series, turns the databases read-only (the agent refuses its own writes meanwhile with 409 DATABASE_UPGRADE_IN_PROGRESS), dumps them, stops MariaDB and copies its data folder and configuration, installs and upgrades the new series and checks it while it is still read-only: tables, error log, the health check, the database lookups of mail, DNS, FTP and the panel, and a sample of the sites that use a database, each against its state before. A check that passed before and fails now puts the old series and the copied data back; otherwise the databases open for writing on the new series. Follow it on GET /system/update/os-security (database.stage, then runs, trigger db-series); a finished upgrade is not undone.

Body fields:

Field Type Required Notes
target string yes pattern=^[0-9]{1,2}\.[0-9]{1,2}$

Request body example:

JSON
{
  "target": "string"
}

Responses:

Status Schema Description
200 ApiSuccess_dict_str__str__ Successful Response
422 HTTPValidationError Validation Error

Response example (200):

JSON
{
  "data": {},
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell
curl -X POST \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  -H "Content-Type: application/json" \
  -d @body.json \
  https://your-server:2000/api/v1/system/update/os-security/database/series

DELETE /api/v1/system/update/os-security/locks/{name}

Lift a version the guarded OS update holds back

Removes WHost's hold on the package's held-back version(s) (an apt pin on the Debian family, a versionlock exclude on the RHEL family): the next run, or a manual one, may install it again. 404 when no version of the package is held back.

Path parameters:

Name Type Required Notes
name string yes —

Responses:

Status Schema Description
200 ApiSuccess_dict_str__Any__ Successful Response
422 HTTPValidationError Validation Error

Response example (200):

JSON
{
  "data": {},
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell
curl -X DELETE \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/system/update/os-security/locks/{name}

POST /api/v1/system/update/os-security/runs/{run_id}/undo

Put back the packages a guarded OS update run installed

Starts whost-os-update undo <run_id> in a unit of its own (it goes on while the agent restarts): every package the run installed (the kernel aside) goes back to the version whose file the run kept, and the version it removes is held back until a newer one is published. The result is a new run in GET /system/update/os-security (runs, trigger undo). 422 for a run that installed nothing that can be put back, 404 for an unknown run.

Path parameters:

Name Type Required Notes
run_id string yes —

Responses:

Status Schema Description
200 ApiSuccess_dict_str__str__ Successful Response
422 HTTPValidationError Validation Error

Response example (200):

JSON
{
  "data": {},
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell
curl -X POST \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/system/update/os-security/runs/{run_id}/undo

GET /api/v1/system/update/settings

Get update settings

Auto-update channel, backup-before-update flag, notify toggles, OS package update prefs.

Responses:

Status Schema Description
200 ApiSuccess_UpdateSettings_ Successful Response

Response example (200):

JSON
{
  "data": {
    "allow_vendor_critical_override": true,
    "auto_update": true,
    "auto_update_type": "security",
    "backup_before_update": true,
    "channel": "stable",
    "notify_available": true,
    "notify_installed": true,
    "os_auto_reboot": "...",
    "os_auto_reboot_time": "04:30",
    "os_packages_auto_mode": "security",
    "os_packages_auto_security": "...",
    "os_packages_check_enabled": true,
    "os_packages_notify_security": true
  },
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell
curl -X GET \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/system/update/settings

PUT /api/v1/system/update/settings

Update settings

Patch any subset of update preferences. Only fields present in the body are mutated; a switch must be a JSON boolean and an unknown field is refused 422. A save that changes nothing writes neither the file nor an audit row; the audit row of a real change names only the fields whose value changed. A change of os_packages_auto_security, os_auto_reboot or os_auto_reboot_time (server time, HH:MM) is applied to the operating system in the background; follow it on GET /system/update/os-security.

Body fields:

Field Type Required Notes
allow_vendor_critical_override boolean no —
auto_update boolean no —
auto_update_type string no —
backup_before_update boolean no —
channel string no —
notify_available boolean no —
notify_installed boolean no —
os_auto_reboot boolean no —
os_auto_reboot_time string no —
os_packages_auto_mode string no —
os_packages_auto_security boolean no —
os_packages_check_enabled boolean no —
os_packages_notify_security boolean no —

Request body example:

JSON
{
  "allow_vendor_critical_override": false,
  "auto_update": false,
  "auto_update_type": "all",
  "backup_before_update": false,
  "channel": "stable",
  "notify_available": false,
  "notify_installed": false,
  "os_auto_reboot": false,
  "os_auto_reboot_time": "string",
  "os_packages_auto_mode": "security",
  "os_packages_auto_security": false,
  "os_packages_check_enabled": false,
  "os_packages_notify_security": false
}

Responses:

Status Schema Description
200 ApiSuccess_UpdateSettings_ Successful Response
422 HTTPValidationError Validation Error

Response example (200):

JSON
{
  "data": {
    "allow_vendor_critical_override": true,
    "auto_update": true,
    "auto_update_type": "security",
    "backup_before_update": true,
    "channel": "stable",
    "notify_available": true,
    "notify_installed": true,
    "os_auto_reboot": "...",
    "os_auto_reboot_time": "04:30",
    "os_packages_auto_mode": "security",
    "os_packages_auto_security": "...",
    "os_packages_check_enabled": true,
    "os_packages_notify_security": true
  },
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell
curl -X PUT \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  -H "Content-Type: application/json" \
  -d @body.json \
  https://your-server:2000/api/v1/system/update/settings

GET /api/v1/system/update/status

Get update install status

Snapshot of the install pipeline — stage, progress 0-100, message, started_at, completed_at, error.

Responses:

Status Schema Description
200 ApiSuccess_UpdateStatus_ Successful Response

Response example (200):

JSON
{
  "data": {
    "channel": "stable",
    "completed_at": "...",
    "current_version": "string",
    "error": "...",
    "last_checked": "...",
    "latest_version": "...",
    "message": "...",
    "progress": 0,
    "stage": "idle",
    "started_at": "...",
    "update_available": false
  },
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell
curl -X GET \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/system/update/status

GET /api/v1/system/update/status/stream

SSE — install progress stream

Server-Sent Events feed of install progress. Closes when stage reaches completed, failed or rolled_back. Binary text/event-stream — no JSON envelope.

Responses:

Status Schema Description
200 — Successful Response

cURL example:

shell
curl -X GET \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/system/update/status/stream
Still Need Help?

Our support team is here around the clock for anything you can't find above.